Skip to content

Commit 43cb07f

Browse files
committed
fix: some improvements
1 parent d33f708 commit 43cb07f

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,32 @@ Once installed, confirm the installation:
1818

1919
## Quick Start 💨
2020

21+
#### 1. Create a New Project
22+
2123
```
2224
bootstrap new myapp --type=rest --router=gin --port=8080 --db=postgres
2325
```
26+
- This command scaffolds a production-ready Go project with:
27+
- Standard project structure
28+
- Database configuration
29+
- Router setup
30+
- Makefile and tooling
31+
32+
#### 2. Prepare the Project
2433

2534
```
2635
cd myapp && make tidy
2736
```
2837

29-
Make sure that the docker and docker compose is installed in your local machine
38+
#### 3. Start Required Services (Database)
3039
```
3140
docker compose up -d
3241
```
3342

3443
Before running ``make run`` make sure that you have running 'db' in docker, running with the same credentials as in .env file.
44+
45+
#### 4. Run the Application
46+
3547
```
3648
make run
3749
```

0 commit comments

Comments
 (0)