Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.83 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.83 KB
Raw

SimpleMath-Flask

README Banner

Hacktoberfest, 2023 with IEEE-VIT Student Branch

SimpleMath-Flask is a Flask app that does math for you. This repository was created to help developers get started with Open Source during Hacktoberfest

NOTE: Check out issues labelled as Hacktoberfest and start contributing!

Made with ❤️ by IEEE-VIT

Support Open Source by participating in Hacktoberfest 💛

Getting started

1.Before setting up the project,Create A virtual environment in the project directory using the following command:

 python -m venv .venv

2.The environment has been created just needs to be activated: bash For mac/linux users: source .venv/bin/activate For windows users: source .venv/Scripts/activate

  1. To setup this project, simply run the following command:
 pip install -r requirements.txt

It should download and setup the dependencies and you're good to go! :)

  1. All the routes are setup inside routes/routes.py. Most of your code should go there.

  2. To start the project, simply run the following command:

 python app.py

  1. All the unit tests are located inside test/test_app.py. All the tests should go there.

  2. To run the test suite, execute the following command:

 python tests/test_app.py

Contributing

To start contributing, check out CONTRIBUTING.md. New contributors are always welcome to support this project. Check out issues labelled as Hacktoberfest if you are up for some grabs! :)

License

This project is licensed under MIT