Code Monkey home page Code Monkey logo

node.js-readme-generator's Introduction

Node.js-README-Generator

7th assignment of UCB Extension Web Development Bootcamp

Here is the link to video about how this application operates

Desciption

If you use a command-line application that asks for information about your application repository, a high-quality and professional README.md file will be generated for you. This README file will include the title of your project and sections for Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.

You will need to enter your project title, description, installation instructions, usage information, contribution guidelines, and test instructions, which will be added to their respective sections in the README file.

You will also need to choose a license for your application from a list of options, which will add a badge for that license to the top of the README file and a notice in the License section explaining which license your application is covered under.

Additionally, you can enter your GitHub username and email address, which will be added to the Questions section of the README file with a link to your GitHub profile and instructions on how to reach you with additional questions.

Finally, if you click on the links in the Table of Contents, you will be taken to the corresponding section of the README file.

Technology Used

Requirements

Please run

npm install

Code Example

This is a function called renderLicenseSection that takes in a license parameter. If the license is not equal to "None", it returns a string with a License section that includes a rendered license badge and a link to the license. If the license is "None", it returns an empty string.

function renderLicenseSection(license) {
    if (license !== "None"){
        return `## Licence
    ${renderLicenseBadge(license)} <br/>
    Licensed under the [${license}](${renderLicenseLink(license)}).`
    }
    else{
        return "";
  }
}

Web application's appearance and functionality

After entering information to the terminal You'll get the following MD file:

Author Info

Liubov Sobolevskaya

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.