Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyphernyx/markdown-file-generator
Module 9 Challenge Node.js: Professional README Generator
https://github.com/cyphernyx/markdown-file-generator
Last synced: about 4 hours ago
JSON representation
Module 9 Challenge Node.js: Professional README Generator
- Host: GitHub
- URL: https://github.com/cyphernyx/markdown-file-generator
- Owner: CypherNyx
- License: mit
- Created: 2023-07-21T23:05:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-22T01:07:35.000Z (over 1 year ago)
- Last Synced: 2023-07-22T04:14:37.652Z (over 1 year ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node.js - Inquirer README Generator
> Module 9 Challenge Node.js: Professional README Generator
This application utilizes Node.js and the [inquirer NPM](https://www.npmjs.com/package/inquirer/v/9.2.8) package to capture user input through the command line interface and generate a personalized README file.
## Table of Contents
* [Demo](#demo)
* [ScreenCaptures](#screenCaptures)
* [Installation](#installation)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Questions](#questions)
## Demo
Here is a link to the video of the Application Demo:
[Node.js README Generator -DEMO ➡️](https://drive.google.com/file/d/1tqJYuQiPVJGjxH1enmB_k1xCpiy5Sx-u/view)
[Sample README.md - File Generated in Demo ➡️](https://github.com/CypherNyx/markdown-file-generator/blob/main/assets/README-inq.md)
## ScreenCaptures
## Installation
To use the README Generator, you'll need to have Node.js installed on your computer. Once you have Node.js set up, you can follow these steps to install and use the application:
1. Clone this GitHub repository to your local machine.
```sh
git clone [email protected]:CypherNyx/markdown-file-generator.git
```
2. Open a terminal or command prompt and navigate to the cloned repository's directory.
3. Run ```npm install``` to install the necessary dependencies.
## Usage
To generate a professional README for your project, follow these steps:
1. Open a terminal or command prompt and navigate to the README Generator directory.
2. Run the application using the command
```sh
node index.js
```
3. Answer the prompted questions about your application repository.
4. Once you have provided all the required information, the application will generate a file named README-inq.md in the same directory with the appropriate sections and content.
### *License - Prompt*
Choose a license for your application from the list of options provided during the README generation process. The selected license will be added as a badge near the top of the generated README. Additionally, a notice will be included in the License section, indicating which license your application is covered under.
### *Contributing - Prompt*
If you want others to contribute to your project, you can include contribution guidelines in the generated README. Provide information on how others can contribute to your project and any guidelines they should follow.
### *Tests - Prompt*
Include instructions on how to run tests for your application in the generated README. By providing clear test instructions, others can easily verify the functionality of your project.
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b suggest/new-feature`)
3. Commit your changes (`git commit -m 'Add some new-feature'`)
4. Push to the branch (`git push origin suggest/new-feature`)
5. Create a new Pull Request
## License
[](https://opensource.org/licenses/MIT)
https://opensource.org/licenses/MIT
## Questions
If you have any questions or need further assistance, you can reach me via the following:
GitHub: [Dahlia Guido's GitHub](https://github.com/CypherNyx)
Email: [email protected]