spotseeker / api

SpotSeeker API
https://api-ryw6.onrender.com
MIT License
0 stars 0 forks source link
django django-rest-framework postgresql python

SpotSeeker

CI Built with Cookiecutter Django Ruff

SpotSeeker is a mobile application designed for travelers to share their experiences through images, discover new places, share their location and recommendations with other travelers around the world.

Requirements

Steps

Create Python virtual environment:

virtualenv venv -p python3.11

Activate the virtual environment

source venv/bin/activate

Install the dependencies:

pip install -r requirements/local.txt

Install pre-commit hooks:

pre-commit install

Run the project:

python manage.py runserver

Run with Docker

$ docker compose up

Running tests with pytest

$ pytest

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Type checks

Running type checks with mypy:

$ mypy spotseeker