https://github.com/codyguru/case-review-api
Case Review System V3 Api
https://github.com/codyguru/case-review-api
django django-rest-framework postgresql
Last synced: 2 months ago
JSON representation
Case Review System V3 Api
- Host: GitHub
- URL: https://github.com/codyguru/case-review-api
- Owner: codyguru
- Created: 2024-12-03T17:00:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-03T17:01:18.000Z (over 1 year ago)
- Last Synced: 2025-06-18T09:50:59.498Z (about 1 year ago)
- Topics: django, django-rest-framework, postgresql
- Language: Python
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Case Review System V3 Api
### Used Technical Stacks
- Django
- Django REST Framework
- Postgre SQL
### Database Migration
You can reference `.env.example`.
```
DB_NAME=case_review
DB_USER=***
DB_PASSWORD=***
DB_HOST=localhost
DB_PORT=5432
```
You need to change `DB_USER` and `DB_PASSWORD` for your PostgreSQL Database.
Then make `.env` in `case_review` directory.
### 1. Clone Repo
If you want to clone this repo, go to the command line and run:
```bash
git clone git@github.com:meta-crawler/case-review-api.git
cd case-review-api
```
### 2. Install Dependencies
Add python virtual env:
```bash
python3 -m venv venv # virtualenv venv
```
To active python virtual env:
```bash
source venv/bin/activate
```
Install Django dependencies:
```bash
pip3 install -r requirements.txt # pip install -r requirements.txt
```
### 3. Seed database
To seed database, open new terminal and please run:
```bash
bash seed.sh
```
### 4. Run Development Environment
In virtual env terminal, please run:
```bash
python3 manage.py runserver
```
### 5. Demo DB
If you want to quick test, you can use dummy db by running:
```bash
psql -U postgres -h 127.0.0.1 -p 5432 -d case_review -f demo_db.sql
```