From 7083d67c9afc3432f86c9860214e0b365bf42a73 Mon Sep 17 00:00:00 2001 From: Shihaam Abdul Rahman Date: Fri, 14 Mar 2025 16:36:27 +0500 Subject: [PATCH] run docs --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 29c7079..7eb2304 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # sarlink-portal-api API for SARLink portal in Django Rest Framework. + + + +## Deployment +1. clone the repo `git clone git@github.com:i701/sarlink-portal-api.git` +2. Create virtual enviroment `virtualenv venv` and activate it `source venv/bin/activate` +3. Install requirements `pip install -r requirements.txt` +4. Copy .env.example to .env and fill in the configs `cp .env.example .env` +5. generate static `python manage.py collectstatic` +6. Run Migrations `python manage.py migrate`