Server Repository

This repository contains the server components, including the database, API, Docker configurations, and more.

Technologies Used

Auth0 for authentication and authorization.
.NET Core 7.0 for building the API.

Installation

To install and try the API locally, follow these steps:

# Clone the repository
git clone <repository_url>

# Navigate to the project directory
cd server

# Build the Docker image for development
docker build -t your_image_name -f Dockerfile.dev .

# Run the Docker container for development
docker run -p 80:80 your_image_name

Usage

Once the Docker container is up and running, you can interact with the API using the provided endpoints.

Contributing

Pull requests and contributions are welcome. Please feel free to fork the repository and submit your changes.

APIs

Database Schema Updates

We leverage neon.tech for a serverless Postgres hosting. One of the advantages of neon.tech is DB branching where we can branch a DB off main and apply the migrations to test them before applying them to the main branch.

We have implemented CICD for safe Schema evolution. Please strictly follow this procedure to ensure safe migrations.

Schema Updates:

Create a local branch git checkout -b "my-update". One caveat here is you must use a branch name that isn't in the existing list of migrations. Check the YaqeelDal/Migrations directory for a list of existing migrations.
Make an update to YaqeenDAL/Models directory
Commit and push your branch.
A github actions workflow will run to inspect your change and generate a new migration if needed. If one is generated, it'll get committed to the same branch.
Once that's ready, a job will be pending to deploy your change to a new neon.tech branch. You must approve this job manually every time.
Once it succeeds, a new job will be queued to delete that neon.tech branch. Don't approve it just yet!
Login to neon.tech and visually verify your change (look at the tables, columns, types... whatever you intended to change)
Once confident, approve the second job to delete your neon.tech change.
It's safe to iterate on this multiple times. If you make a subsequent change to the branch, the workflow will start from a clean slate (branch off main) and apply migrations that way. So iterating on your PR is safe and will only generate a single Migration.
Once you commit your change and push it to main, another job will get queued to apply the migrations to the main production database. Approve that and monitor it for completion!

YaqeenAdel/server