https://github.com/mauryiv/list-generator

https://github.com/mauryiv/list-generator

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/mauryiv/list-generator
• Owner: MauryIV
• Created: 2024-03-08T00:17:30.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-10T04:58:49.000Z (10 months ago)
• Last Synced: 2024-10-15T05:23:36.472Z (3 months ago)
• Language: JavaScript
• Size: 43.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# List Generator 



## Description

This program works on Node.js in the terminal to ask the user for a list of tasks the user needs to do. Then it creates an HTML doc of that list, organizing it by priority.

## Table of Contents

- [Title](#title)

- [Description](#description)

- [Badges](#badges)

- [Visuals](#visuals)

- [Installation](#installation)

- [Usage](#usage)

- [Tests](#tests)

- [Questions](#questions)

- [Roadmap](#roadmap)

- [Contributing](#contributing)

- [Authors and Acknowledgment](#acknowledgment)

- [License](#license)

- [Project Status](#status)



## Badges

![Maury Hughes IV](https://img.shields.io/badge/Maury%20Hughes%20IV-5A2BE2)

![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)



## Installation

Need Node as well as all dependencies listed in package.json. A simple npm install in the command line, should take care of that.



## Usage

Good for making yourself a to do list.



## Visuals

![Command prompts](https://github.com/MauryIV/list-generator/assets/146037880/3e865654-e54a-465c-ad11-c2e8666b2fcc)

![HTML Output](https://github.com/MauryIV/list-generator/assets/146037880/b467e96a-ee5b-44c6-a8df-69769b0425c7)

![Site display of HTML](https://github.com/MauryIV/list-generator/assets/146037880/646fdb91-79da-4643-8a1f-9f7ef0c31230)

![Running tests](https://github.com/MauryIV/list-generator/assets/146037880/4ae1e57f-a55a-45c5-b2b4-b2f0e5e2848a)



## Tests

Tests for each class are written in the code under the tests folder.



## Questions

If you have any questions about the contents. Please feel free to reach out!

Here is my [Github](https://github.com/MauryIV) as well as my email .



## Roadmap

NA



## Contributing

Always open to any input to improve or simplify the code. Feel free to reach out.



## Authors and Acknowledgment

Most base code from DU coding bootcamp and thier knowledge and guidance to help me finish this as well.



## License

MIT License © 2024 Maury Hughes IV

Please refer to this link, [License: MIT](https://opensource.org/licenses/MIT) for more information.



## Project Status

Complete

[back to top](#title)