Skip to content

Commit 9034d41

Browse files
committed
docs(readme): add guide
1 parent 5ee9c66 commit 9034d41

File tree

3 files changed

+79
-0
lines changed

3 files changed

+79
-0
lines changed

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
- [Core Features](#core-features)
66
- [Technology Stack and Features](#technology-stack-and-features)
77
- [Planned Features](#planned-features)
8+
- [Getting Started](#getting-started)
9+
- [Development](#development)
10+
- [VSCode Devcontainer](#vscode-devcontainer)
11+
- [Without VSCode Devcontainer](#without-vscode-devcontainer)
12+
- [Refactored Markdown Files](#refactored-markdown-files)
813
<!--toc:end-->
914

1015
## Core Features
@@ -39,3 +44,77 @@
3944
- :dollar: Deploy live demo to [![Fargate](https://img.shields.io/badge/Fargate-white.svg?logo=awsfargate)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html)
4045
- Provision with [![Terraform](https://img.shields.io/github/stars/hashicorp/terraform?logo=terraform&label=Terraform)](https://github.com/hashicorp/terraform) IaC
4146
- Push built images to ECR and Dockerhub
47+
48+
## Getting Started
49+
50+
Build images with:
51+
52+
```bash
53+
docker compose -f compose-dev.yaml build
54+
```
55+
56+
Copy environment file:
57+
58+
```bash
59+
cp .env.sample .env
60+
```
61+
62+
Add your following API keys and value to the respective file: `./envs/backend.env`, `./envs/youtube.env` and `.env`.
63+
64+
```bash
65+
OPENAI_API_KEY=sk-proj-...
66+
POSTGRES_DSN=postgresql://postgres...
67+
YOUTUBE_API_KEY=...
68+
```
69+
70+
Set environment variables in shell: (compatible with `bash` and `zsh`)
71+
72+
```bash
73+
set -a; for env_file in ./envs/*; do source $env_file; done; set +a
74+
```
75+
76+
Start production containers:
77+
78+
```bash
79+
docker compose up -d
80+
```
81+
82+
## Development
83+
84+
### VSCode Devcontainer
85+
86+
> [!WARNING]
87+
> Only replace the following if you plan to start debugger for FastAPI server in VSCode.
88+
89+
Replace `./compose-dev.yaml` entrypoint to allow debugging FastAPI server:
90+
91+
```yaml
92+
# ...
93+
api:
94+
# ...
95+
# entrypoint: uv run fastapi run api/main.py --root-path=/api --reload
96+
# replace above with:
97+
entrypoint: bash -c "sleep infinity"
98+
# ...
99+
```
100+
101+
```bash
102+
code --no-sandbox .
103+
```
104+
105+
Press `F1` and type `Dev Containers: Rebuild and Reopen in Container` to open containerized environment with IntelliSense and Debugger for FastAPI.
106+
107+
### Without VSCode Devcontainer
108+
109+
Run development environment with:
110+
111+
```bash
112+
docker compose -f compose-dev.yaml up -d
113+
```
114+
115+
## Refactored Markdown Files
116+
117+
The following markdown files provide additional details on other features:
118+
119+
- [`./docs/mcp.md`](./docs/mcp.md)
120+
- [`./docs/supabase.md`](./docs/supabase.md)

docs/mcp.md

Whitespace-only changes.

docs/supabase.md

Whitespace-only changes.

0 commit comments

Comments
 (0)