https://github.com/richllew182/readme-generator

Module 11 Challenge for EDX Bootcamp
https://github.com/richllew182/readme-generator

Last synced: about 2 months ago
JSON representation

Module 11 Challenge for EDX Bootcamp

• Host: GitHub
• URL: https://github.com/richllew182/readme-generator
• Owner: RichLlew182
• License: mit
• Created: 2024-02-02T18:28:18.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-06T09:55:59.000Z (11 months ago)
• Last Synced: 2024-02-06T10:39:05.415Z (11 months ago)
• Language: JavaScript
• Size: 160 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# README Generator

Module 11 Challenge for EDX Bootcamp

  Table of Contents

  


    


      Description

      


        
Built With

        
Dependencies

      

    

    


        Installation

    

    
Usage

    
License

    
Contact

    
Acknowledgments

  


## Description



    

  




 
This was the 11th homework challenge for the EDX Bootcamp in Front End Development.
 


   
Our task was to build a README generator that runs on the server using Node.js. The app retrieves data based on user input using the Inquirer package and then writes that data to a README file that can be found in the output folder.

 


### Built With

* ![JavaScript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E)

* ![Node.js](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)

### Dependencies

* Inquirer version 8.2.4

## Installation

  To install this app, please open the index.js file in the integrated terminal and then type the following in your terminal:

~~~sh

node index.js

~~~

## Usage

To use this project, first right click the index.js file and select 'Open in Integrated Terminal' from the popup menu. 

You will be prompted with several questions about your project, such as Title, Description, License, Usage, Installation etc.

Most questions are simple inputs, but some are lists, such as the License question. Some questions also require answers, such as Title and Description, whereas other questions like Testing and Contributing can be skipped by pressing enter. This will add 'N/A' to that section in the README file. 

Once you have added all your information you will be shown a success message, and a README.md file will be generated in the output folder.

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

## Contact

Richard Llewellyn - [email protected] 

Sample README file: [https://github.com/RichLlew182/readme-generator/blob/main/output/README.md](https://github.com/RichLlew182/readme-generator/blob/main/output/README.md)

Video Presentation Link: [https://app.screencastify.com/v3/watch/3KnXy2QGvCR8S3SDuFWz](https://app.screencastify.com/v3/watch/3KnXy2QGvCR8S3SDuFWz)

Project Repo Link: [https://github.com/RichLlew182/readme-generator](https://github.com/RichLlew182/readme-generator)

## Acknowledgments

* [Img Shields](https://shields.io)

* [Best README Template](https://github.com/othneildrew/Best-README-Template)