Coder Social home page Coder Social logo

pro-readme-file-generator's Introduction

Pro README File Generator

Pro README File Generator

This repository was created to allow the users to create a professional README.md file based on their answers to a set of questions that are created specifically to create the README.md file.

This project contain a few pages but the main page to run the README.md generator is located at index.js, this function is possible via nodeJS to allow the project to create files and in this project is to create README.md file based on set of questions.

This project is mainly focused on showing up my skills in JS with the integration of NodeJS libraries and improve on it as I progress my journey of learning full stack.

The README.md file name will be created based on the project tile + "-README.md" as an example Weather-App-API-README.md.

GitHub Repo URL

https://github.com/AllenHirmiz/Pro-README-File-Generator

Test ReadMe file

https://allenhirmiz.github.io/Pro-README-File-Generator/main/README-Files/README-File-Generator-README.md

Table of Contents

This project gets run via command line only and it doesn't have a page to run and display the questions needed to create the README.md file.

Installation

Command Line

Technologies Used

Pro README File Generator project is built using the following technologies:

JavaScript: Dynamic and interactive elements, such as animations and form validation. NodeJS: inquirer Library:

Mock-Up

The following image shows the web application's appearance and functionality:

Command line Screenshot

Screenshot of the command line that is needed to create README.md file. Screenshot of the command line that is needed to create README.md file

Command line file example video

Click on the screenshot to direct you the youtube video of a demo for this project. Watch the video

pro-readme-file-generator's People

Contributors

allenhirmiz 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.