Skip to content

Commit cef7285

Browse files
author
Vic Shóstak
authored
Merge pull request #11 from create-go-app/dev
Update README
2 parents 2ef0f22 + 989c4e8 commit cef7285

File tree

1 file changed

+10
-17
lines changed

1 file changed

+10
-17
lines changed

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,24 @@ Package [`net/http`](https://golang.org/pkg/net/http/) provides HTTP client and
1414
cgapp create
1515

1616
# Choose a backend framework:
17-
# > net/http
18-
# Fiber
17+
# net/http
18+
# > Fiber
1919
```
2020

21-
2. Run Docker container with database (_by default, for PostgreSQL_):
21+
2. Rename `.env.example` to `.env` and fill it with your environment values.
22+
3. Install [Docker](https://www.docker.com/get-started) and the following useful Go tools to your system:
2223

23-
```bash
24-
make docker.postgres
25-
```
26-
27-
3. Apply migrations:
28-
29-
```bash
30-
make migration.up user=<db_user> pass=<db_pass> host=<db_host> table=<db_table>
31-
```
32-
33-
4. Rename `.env.example` to `.env` and fill it with your environment values.
24+
- [golang-migrate/migrate](https://github.com/golang-migrate/migrate#cli-usage) for apply migrations
25+
- [github.com/swaggo/swag](https://github.com/swaggo/swag) for auto-generating Swagger API docs
26+
- [github.com/securego/gosec](https://github.com/securego/gosec) for checking Go security issues
3427

35-
5. Run project by this command:
28+
4. Run project by this command:
3629

3730
```bash
38-
make run
31+
make docker.run
3932
```
4033

41-
6. Go to API Docs page (Swagger): [localhost:5000/swagger/index.html](http://localhost:5000/swagger/index.html).
34+
5. Go to API Docs page (Swagger): [127.0.0.1:5000/swagger/index.html](http://127.0.0.1:5000/swagger/index.html)
4235

4336
## 📦 Used packages
4437

0 commit comments

Comments
 (0)