VeganPot

• Image and short bio of project
• OR Demo GIF and bio

Description

Provide a short description explaining the what, why, and how of your project. Use the following questions as a guide:

• What was your motivation?
• Why did you build this project? (Note: the answer is not "Because it was a homework assignment.")
• What problem does it solve?
• What did you learn?

Table of Contents

If your README is long, add a table of contents to make it easy for users to find what they need.

• Installation
• Usage
• Acknowledgements
• Technologies
• Features & Implementation
• Upcoming Features
• Feedback
• How to Contribute
• Tests
• License

Installation

What are the steps required to install your project? Provide a step-by-step description of how to get the development environment running.

Usage

1. To regenerate requirements.txt from Pipfile run:

pipenv requirements > requirements.txt

2. To format and lint python files, start the virtual environment by running:

pipenv shell

Then run: a. To see what will be changed

bash scripts/check-style.sh

b. To apply auto-fixes

bash scripts/fix-style.sh

Provide instructions and examples for use. Include screenshots as needed.

To add a screenshot, create an assets/images folder in your repository and upload your screenshot to it. Then, using the relative filepath, add it to your README using the following syntax:

![alt text](assets/images/screenshot.png)

Acknowledgements

List your collaborators, if any, with links to their GitHub profiles. Collaborators: 1. 2. 3. 4. 5.

If you used any third-party assets that require attribution, list the creators with links to their primary web presence in this section. Credits:

Design:
    HTML5UP (html5up.net)

Icons:
    Font Awesome (fontawesome.io)

Other:
    Animations (https://alvarotrigo.com/blog/)
    Menu (https://www.cssscript.com/expanding-dropdown-menu/)

If you followed tutorials, include links to those here as well.

Technologies

• JavaScript
• ReactJS
• Redux
• ExpressJS
• NodeJS
• Python
• Flask
• SQL
• PostgreSQL
• Sequelize
• SQLAlchemy
• HTML
• CSS
• Mocha
• Chai
• Pytest
• Docker

Features & Implementation

If your project has a lot of features, list them here.

1. Dark & Light Theme
2. Nav menu changes to hamburger menu on smaller devices
3. Typewriter effect on greeting
4. frontend routes document
5. API routes document (if you have a backend API)
6. Redux store tree document (if you used Redux)

Upcoming Features

• Planning to add

Feedback

Feel free to send me feedback by filing an issue. Feature requests are always welcome. If you wish to contribute, please take a quick look at the guidelines!

If you wish to contribute or if there's anything you would like to chat about, send me an email @[email protected]!

How to Contribute

The contributing guidelines can be found at How to Contribute.

EDIT CONTRIBUTING.md

Tests

Go the extra mile and write tests for your application. Then provide examples on how to run them here.

License

The last section of a high-quality README file is the license. This lets other developers know what they can and cannot do with your project. If you need help choosing a license, refer to choosealicense.com.