Giter VIP home page Giter VIP logo

readme-generator's Introduction

ReadMe-Generator

Description

I really enjoyed working on this project. I'm super happy with my results and the work I put into this. I did struggle a bit with a couple of functions, for example, the init function. I wasn't sure how to incorporate inquirer.prompt into the function and call the questions array. However, once I looked at a couple documentations and examples online, it made a lot of sense and I was able to finish the index.js file.

I had the most fun working on the generateMarkdown file. At first I wasn't sure what to do, which seems to be the case whenever I have to write functions, but after I realize its rendering the license and a bunch of if/else statements attached, it all made sense. Instead of doing if/else statements, I wanted to practice on my switch statments which I've been having a bit of trouble with. Once all the render functions was done, the results kept coming up undefined until I noticed I forgot to return my variables. After everything was fixed, the project is running as I like it.

Installation

  1. Download or clone repository
  2. Node.js is required to run application
  3. npm install inquirer

Usage

The application will be invoked by using the following command:

node index.js

After a series of prompts would pop up where the user would answer to generate the ReadMe. This can be seen in the images and gif below.

command line prompts from inquirer to answer questions

readme markdown generated from answering questions

readme preview instead of markdown

gif of video demo, a litte glitchy

Links

DEMO LINK

Github

readme-generator's People

Contributors

gt1222 avatar

Watchers

 avatar

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.