Safe_Share/README.md

30 lines
422 B
Markdown

# Safe Share
## Installation
```bash
# Clone the repository
python -m venv venv
## On linux
source venv/bin/activate
## On Windows
venv\Scripts\activate
cd safeshare
pip install -r requirements.txt
```
## Usage
```bash
# Run backend using docker-compose
docker-compose up
```
## Endpoints
- `/admin/` - Admin Panel
- Additional Endpoints can be found in [Routes.md](./study_together/study_together_app/Routes.md)