itisfilipe / api-example-django Goto Github PK

Changes

1. Folder structure:

   1. Split frontend, backend and infrastructure code in a mono-repo.
   2. Break down the existing application into modules and extract the common configs into a core folder.

   .
   ├── README.md
   ├── backend
   │   ├── __init__.py
   │   ├── apps
   │   │   ├── __init__.py
   │   │   ├── accounts
   │   │   ├── auth
   │   │   ├── booking
   │   │   └── dashboard
   │   ├── core
   │   │   ├── __init__.py
   │   │   ├── settings.py
   │   │   ├── urls.py
   │   │   └── wsgi.py
   │   ├── manage.py
   │   ├── requirements.txt
   │   └── tests
   │       ├── __init__.py
   │       └── readme.md
   ├── docker-compose.yml
   ├── frontend
   │   ├── README.md
   │   ├── package.json
   │   ├── public
   │   ├── src
   │   └── yarn.lock
   └── infrastructure
       ├── docker
       │   ├── data
       │   ├── dbsnapshot
       │   ├── drchrono-dockerfile
       │   └── environment.example
       └── infra.yaml
   

2. Add versioning to APIs, i.e. apps/accounts/api/v1/*

3. Configs stored in the environment to easily vary between deploys

4. CI/CD to every PR, easily configured with GitHub actions + any cloud service

5. Infrastructure as code, AWS cloudformation or terraform

6. Infrastructure:
   

7. Sequence diagram:

• The connection from the WebSocket to the Client should not be the responsibility of the REST server.
• The messages should be saved in the DB and published in the Broker.
• The client could only receive new messages via WebSockets, the insertion of new messages would still occur via HTTP.
• The first call to fill the whole dashboard should be made to the REST API.