initial readme

initial readme
This commit is contained in:
xrando 2023-11-01 11:53:22 +08:00
parent 7fc266c7a6
commit 86955e8e40
1 changed files with 29 additions and 0 deletions

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# 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)