A short and informative description of your full-stack project. Explain what the project does, the problem it solves, and its target audience.
List the programming languages, frameworks, libraries, and databases used in your project. Briefly explain why you chose these technologies.
-
Backend: Python + Django
-
Frontend: TypeScript + React
-
Database: PostgreSQL
-
Observability: Signoz
-
CI/CD: GitHub Actions?
-
Hosting: AWS EC2
-
Other Tech: Docker
This section guides users on how to set up and run the project locally.
-
Prerequisites: List any software or tools required to run the project.
-
Installation: Provide step-by-step instructions on installing dependencies and configuring the project.
-
Running the Project: Explain how to start the development server and access the application.
Describe the overall directory structure of your project. Briefly explain the purpose of each main folder.
(Optional) If you welcome contributions to your project, outline the contribution guidelines. Include details on how to submit pull requests, coding style conventions, and testing procedures.
Specify the license under which your project is distributed. Include a link to the license file.