stemitom / desk-square

API for an event management tool (ex. Meetup and EvenBrite) written in drf django.

desk-square

API for an event management tool (ex. Meetup and EventBrite) written in drf django.

Getting Up and Running Locally with Docker

The steps below will get you up and running with a local development environment. All of these commands assume you are in the root of your generated project.

Prerequisites

• Docker
• Docker-Compose

Steps

• Clone the repo git clone https://github.com/stemitom/desk-square
• Navigate to repo directory cd desk-square
• Build and run the docker-compose file docker-compose up -d build
• Run migrations docker-compose exec web poetry run python manage.py migrate
• Create a superuser docker-compose exec web poetry run python manage.py createsuperuser

Postman Documentation

Project To-Do

• Add Project documentation to github README.md
• Add Payment feature through stripe
• Move existing tests to Pytest and add more (comprehensive) tests
  • Accounts
    • Views
      • Login (1)
      • Signup (1)[3]
      • User Profile (1)
      • Logout (5)
      • Change Password (3)
      • Request Activation (1)
      • Request Password Reset (2)
  • Add (devops) services
    • Grafana
    • Prometheus
    • Loki
    • Supervisord for managing processes
    • Gunicorn