Skip to content

Commit 5f727a0

Browse files
committed
updated README.md
1 parent c829eb3 commit 5f727a0

File tree

1 file changed

+9
-27
lines changed

1 file changed

+9
-27
lines changed

README.md

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This repository provides a template for building a RESTful API using Go with fea
1717
## Folder structure
1818

1919
```
20-
my-rest-api/
20+
golang-rest-api-template/
2121
|-- bin/
2222
|-- cmd/
2323
| |-- server/
@@ -30,12 +30,6 @@ my-rest-api/
3030
| |-- user.go
3131
| |-- database/
3232
| |-- db.go
33-
|-- internal/
34-
| |-- utils/
35-
| |-- helper.go
36-
|-- web/
37-
| |-- static/
38-
| |-- templates/
3933
|-- scripts/
4034
|-- Dockerfile
4135
|-- go.mod
@@ -47,31 +41,19 @@ my-rest-api/
4741

4842
1. **`bin/`**: Contains the compiled binaries.
4943

50-
2. **`cmd/`**: Main applications for this project. The directory name for each application should match the name of the executable you want to generate.
44+
2. **`cmd/`**: Main applications for this project. The directory name for each application should match the name of the executable.
5145

52-
- **`main.go`**: The entry point for your application.
46+
- **`main.go`**: The entry point.
5347

5448
3. **`pkg/`**: Libraries and packages that are okay to be used by applications from other projects.
5549

56-
- **`api/`**: All your API logic.
57-
- **`handler.go`**: Your HTTP handlers.
58-
- **`router.go`**: Your routes.
59-
- **`models/`**: Your data models.
50+
- **`api/`**: API logic.
51+
- **`handler.go`**: HTTP handlers.
52+
- **`router.go`**: Routes.
53+
- **`models/`**: Data models.
6054
- **`database/`**: Database connection and queries.
6155

62-
4. **`internal/`**: Private application and library code. This is code you don't want others importing in their applications or libraries.
63-
64-
- **`utils/`**: Various utilities that you use internally.
65-
66-
5. **`web/`**: All your web server related things like static files, templates, etc.
67-
68-
6. **`scripts/`**: Various build, install, analysis, etc., scripts for your application.
69-
70-
7. **`Dockerfile`**: If you use Docker, you'll include a Dockerfile here.
71-
72-
8. **`go.mod` and `go.sum`**: The Go module file and its checksum.
73-
74-
9. **`README.md`**: Project documentation and setup guide.
56+
4. **`scripts/`**: Various build, install, analysis, etc., scripts.
7557

7658
## Getting Started
7759

@@ -98,7 +80,7 @@ cd golang-rest-api-template
9880
3. Build and run the Docker containers
9981

10082
```bash
101-
make setup && make build
83+
make setup && make build && make up
10284
```
10385

10486
### Environment Variables

0 commit comments

Comments
 (0)