This project is a README.md file generator using Nodejs. The user is prompted with questions in the terminal. The answers will be used to fill the README.md file that will then be generated by the app.
Project is created using:
- HTML
- CSS
- JavaScript
- Nodejs
readme.walkthrough.mov
Final app should look something like this:
Here are some guidelines for installing the project on your local machine in order to be able to try it:
-
Since Node.js applications don't have a front end, clone or download the repository to your own local machine and run it from your command line.
-
Change the working directory to
cd Develop/ -
Then, make sure that your repo includes a package.json with the required dependencies. You can create one by running
npm initin your command line. -
Run
npm iornpm installin order to download all the dependencies. Make sure to also download Inquirer.js by enteringnpm install inquirerin your terminal in the root directory of the project. Learn more about this package on npm documentation. -
Run
node index.jsin your terminal to launch the application, the first question will appear in your terminal. -
Enjoy and don't hesitate to contribute! 🙂