Giter VIP home page Giter VIP logo

erikplachta / readme-builder-with-nodejs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from coding-boot-camp/potential-enigma

0.0 0.0 0.0 54.37 MB

Using Node.js to build a professional README.md dynamically based on user input. Lets you quickly and easily generate a README file by using a node via the command-line. This allows the developers to quickly generated uniform READMEs for all projects.

License: GNU General Public License v3.0

JavaScript 100.00%
javascript nodejs readme readme-generator

readme-builder-with-nodejs's Introduction

readme-builder-with-nodejs's People

Contributors

erikplachta avatar xandromus avatar

readme-builder-with-nodejs's Issues

Feature: Prompt Email

WHEN I enter my email address
THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions

Feature: Prompt for Description

WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions

THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests

Feature: Generate a README.md File with Node.js

User Story

AS A developer

  • I WANT a README generator
  • SO THAT I can quickly create a professional README for a new project

Create a command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer package (Links to an external site.).

Example of professional readme


Tasks

GIVEN a command-line application that accepts user input

  • WHEN I am prompted for information about my application repository

    • THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions
  • #4

  • #5

  • #6

  • #7

  • #8

  • #9

  • #11

Feature: Video Demonstrating Application

Because this application won’t be deployed, you’ll also need to provide a link to a walkthrough video that demonstrates its functionality.

You’ll need to submit a link to the video and add it to the README of your project.

  • A walkthrough video that demonstrates the functionality of the README generator must be submitted and a link to the video should be included in your README file.
  • The walkthrough video must demonstrate how a user would invoke the application from the command line.
  • The walkthrough video must demonstrate how a user would enter responses to all of the prompts in the application.
  • The walkthrough video must demonstrate a generated README that matches the user input and has a functioning table of contents.

Feature: Prompt for License with Options

WHEN I choose a license for my application from a list of options

THEN a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.