Backend API for React Native hot food locations app
An in-depth paragraph about your project and overview of use.
You can view the design document here.
You can view additional resources here.
You will need the following dependencies to run or contribute to this project:
See the Dependencies document for installation steps for these dependencies.
Git clone this repo and cd into the directory.
To run:
docker compose build
docker compose up -d
Access server at http://localhost:8000
Sample data can be accessed with http://localhost:8000/locations
To shut down: docker compose down
-
To get data to print from google API you must first create your own Googole API key (Eventually we will have a business account this is for testing purposes for now)
-
GoogleAPI Use this link for API steps
-
Once API key is created create a .env file name your key GOOGLE_MAP_API_KEY="YOUR-API-KEY-HERE" **very important do not put your API key in the googpleAPI file you will risk it being exposed on github!
-
add .env to the .gitignore file so it is not exposed on github
-
test out by running the command python3 googleAPI.py
-
data from google api should be printed to console
***in settings for google api make sure maps are enabled for API key to be valid- questions about this can be found at link listed above
We are using pytest as our test suite. Please write tests for any new features: https://semaphoreci.com/community/tutorials/building-and-testing-an-api-wrapper-in-python
All tests are currently in the /tests directory, run this command in the root directory:
python -m pytest
for current test output.
Fork this repo and make a feature branch for pull requests, or join our Discord to be added as a contributor.
Any advice for common problems or issues.
command to run if program contains helper info
This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details