Skip to content

Commit d621b69

Browse files
committed
fix: Add makefile and readme
1 parent 67a4f92 commit d621b69

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,11 @@ install-frontend:
99
cd frontend && ./install.sh
1010

1111
install: install-backend install-frontend
12+
13+
run-backend:
14+
cd backend && ./run.sh
15+
16+
run-frontend:
17+
cd frontend && ./run.sh
18+
19+
.DEFAULT_GOAL := install

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Databutton app
2+
3+
This project consists of a FastAPI backend server and a React + TypeScript frontend application exported from Databutton.
4+
5+
## Stack
6+
7+
- React+Typescript frontend with `yarn` as package manager.
8+
- Python FastAPI server with `uv` as package manager.
9+
10+
## Quickstart
11+
12+
1. Install dependencies:
13+
14+
```bash
15+
make
16+
```
17+
18+
2. Start the backend and frontend servers in separate terminals:
19+
20+
```bash
21+
make run-backend
22+
make run-frontend
23+
```
24+
25+
## Gotchas
26+
27+
The backend server runs on port 8000 and the frontend development server runs on port 5173. The frontend Vite server proxies API requests to the backend on port 8000.
28+
29+
Visit <http://localhost:5173> to view the application.

0 commit comments

Comments
 (0)