Skip to content

Commit cc8445c

Browse files
committed
README tweaks
1 parent 7c7c7b8 commit cc8445c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,20 @@ Note: This project is no longer maintained. Originally private, some parts may n
66

77
Scanbandz processed over $100,000 in payments and donations, and I’m open-sourcing it in case it's helpful to others. In production, the backend ran as a scalable cluster with PostgreSQL and Redis databases, and Celery workers handled background tasks like ticket sending. If revisiting, I would 1) add Redis-backed rate limiting to authentication endpoints and 2) move workers to a separate Docker image and separate workers by task type (e.g., payments, ticketing, communications).
88

9-
Note: Instructions for running may need troubleshooting due to the quick port to open source.
10-
9+
I wrote this three times over my college career. The first time was when I learned to code (entirely in Django), the second time was fixing all my mistakes (still in Django), and the third was after much experience and separating the frontend and backend (FastAPI). It was a great learning experience, and I hope it helps you too. I will never open source my Django code as it haunts my sleep.
1110

11+
Note: Instructions for running may need troubleshooting due to the quick port to open source.
1212

1313
## Features
1414

1515
- FastAPI backend with multiple APIs to manage events, guests, tickets, and payments.
16-
- Integration with Celery for background task processing.
16+
- Integration with Celery and Redis for background task processing.
1717
- Support for PostgreSQL database with SQLAlchemy and Alembic for migrations.
1818
- Docker and Docker Compose support for development and production.
1919
- Supervisord for process management in production.
2020

2121
## Table of Contents
22+
2223
- [Installation](#installation)
2324
- [Running the Application](#running-the-application)
2425
- [Development Setup](#development-setup)
@@ -86,6 +87,7 @@ This will spin up the development environment with a PostgreSQL database.
8687
```bash
8788
docker-compose -f .devcontainer/dev-docker-compose.yml up
8889
```
90+
8991
5. Run database migrations:
9092

9193
```bash
@@ -134,6 +136,7 @@ docker run -p 8080:8080 scanbandz-backend
134136
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
135137

136138
### Key Sections Explained:
139+
137140
- **Features**: Highlights the major functionalities of your backend.
138141
- **Installation**: Provides steps to set up the project.
139142
- **Running the Application**: Details how to run the application with `gunicorn`, `supervisord`, and Docker.

0 commit comments

Comments
 (0)