Skip to content

Commit

Permalink
Add node.js project to the github repo
Browse files Browse the repository at this point in the history
  • Loading branch information
itcreativeusa committed May 16, 2023
1 parent 2c95774 commit 07d3136
Show file tree
Hide file tree
Showing 10 changed files with 925 additions and 129 deletions.
Binary file added .DS_Store
Binary file not shown.
131 changes: 2 additions & 129 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,130 +1,3 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
.DS_Store/
02-Homework-Challenge/
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# you-better-readme

## Description

Link to deployed application
https://itcreativeusa.github.io/you-better-readme

Github link
https://github.com/itcreativeusa/you-better-readme

This you-better-readme was created as a bootcamp everyweek student challege.
It's a command-line application that accepts user input for generating readme file with the title of project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.


## Table of Contents (Optional)

- [Installation](#installation)
- [Usage](#usage)
- [Requirements](#requirements)
- [Credits](#credits)
- [License](#license)

## Installation

N/A

## Requirements

No special requirements

## Usage

Run node index.js in terminal.
Follow the prompt questions and enter information about application repository.
The file readme.md will be generated in a root folder

Simply add text to the text field and press save. after reloading the page, the text will be available.
Screenshot located in `assets/images` folder

![you-better-readme](utils/img/screenshot.png)

## Credits

Starter code in files : index.html, style.css provided by Berkeley Bootcamp for studying purposes.

## License

Please refer to the LICENSE in the repo.
81 changes: 81 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
// Include packages needed for this application
const inquirer = require("inquirer");
const generateMarkdown = require("./utils/generateMarkdown.js");
// fs is a Node standard library package for reading and writing files
const fs = require("fs");
// Create an array of questions for user input
const questions = [
{
type: "input",
name: "title",
message: "Title",
},
{
type: "input",
name: "description",
message: "Description",
},
{
type: "input",
name: "tableOfContents",
message: "Table of Content",
},

{
type: "input",
name: "installation",
message: "Instalation",
},
{
type: "input",
name: "usage",
message: "Usage",
},
{
type: "checkbox",
name: "license",
message: "Choose license from the list",
choices: ["ISC", "MIT", "Unlicense", "GNU GPL"],
},
{
type: "input",
name: "contributing",
message: "Contributing",
},
{
type: "input",
name: "tests",
message: "Tests",
},
{
type: "input",
name: "github",
message: "Enter your GitHub Username",
},
{
type: "input",
name: "email",
message: "Enter your Email",
},
];

// Create a function to write README file
// Ternary operator takes in a condition followed by a question mark (?)
// then an expression to execute if the condition is truthy followed by a colon (:)
// and finally the expression to execute if the condition is falsy.
function writeToFile(fileName, data) {
fs.writeFile(fileName, data, (err) =>
err ? console.error(err) : console.log("Readme.md successfully generated!")
);
}

//Create a function to initialize app
function init() {
inquirer.prompt(questions).then(function (data) {
const markdownText = generateMarkdown(data);
writeToFile("README.md", markdownText);
});
}

// Function call to initialize app
init();
Loading

0 comments on commit 07d3136

Please sign in to comment.