This project is a console app created for my coding bootcamp. The goal of this project is to take in user input and generate a markdown README file that could be included in a project. To accomplish this I use node.js to execute javascript outside of a browser.
https://drive.google.com/file/d/1F-aIWc5laac41sxmZpvBXWW98sPad9aD/view
Must have node installed on your machine. I used Node 20 when developing. You will also need to install inquirer which is an npm package used to recieve user input. To do that follow the usage instructions below.
To use this project you have to have Node.js installed on your machine. Download the source code and create a new folder in the root of the source code called 'export'. This export folder is where the newly generated readme.md file will be created. After that in a terminal run the command npm install to download the dependencies for the project. Once installed run the command "node index.js" in the terminal to start the app.
For this project I worked with two classmates Will Schickler and Shelby Hutchinson. The exact files that we worked on together are the index.js and utils/generateMarkdown.js. The code in these files are not the exact same but just similar as we worked together via voice chat.
https://opensource.org/licenses/MIT Copyright Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
For any questions feel free to connect with me on github or by email.
GitHub: ChaseLee21 Email: seeberger.chase@gmail.com