Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hexarchy/student-management
https://github.com/hexarchy/student-management
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hexarchy/student-management
- Owner: HexArchy
- Created: 2024-11-30T11:17:50.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-11-30T11:44:35.000Z (about 1 month ago)
- Last Synced: 2024-11-30T12:21:51.498Z (about 1 month ago)
- Language: TypeScript
- Size: 64.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Student Management System
## Prerequisites
- Docker
- Docker Compose
## Setup
1. Clone repository
2. Create `.env` files:
```bash
# api/.env
POSTGRES_USER=postgres
POSTGRES_PASSWORD=password
POSTGRES_DB=students
POSTGRES_HOST=db
POSTGRES_PORT=5432
```
## Development
```bash
# Start services
docker-compose up -d
# Apply migrations
docker-compose exec api alembic upgrade head
# Seed database
docker-compose exec api python -m app.infrastructure.database.seed
# View logs
docker-compose logs -f
```
## API Documentation
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc
## Project Structure
```
.
├── api/ # FastAPI backend
├── frontend/ # React frontend
├── docker-compose.yml
└── README.md
```