Skip to content

Commit 118821e

Browse files
committed
🍉update README.md
1 parent 8c4a936 commit 118821e

File tree

2 files changed

+27
-5
lines changed

2 files changed

+27
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,34 @@ in front-end:
2727

2828
## How to run
2929

30-
In root of source you should run your go project
30+
🚦I included the .env file intentionally in the project so that you can see how the services work and with what settings. Otherwise, it should not be displayed in the project.
31+
32+
With Docker🐳:
33+
34+
1-Run DB and API service
35+
```bash
36+
docker composer up -d
37+
```
38+
2- Run nextjs
39+
```bash
40+
cd ./frontend
41+
yarn install
42+
yarn run dev
43+
```
44+
45+
Manaul✌️:
46+
47+
1-Create DB based on .env file(you can change it in .env file)
48+
49+
2-In root of source you should run your go project
3150
```bash
51+
go mod tidy
3252
go run main.go
3353
```
34-
In root frontend directory you should run your next project
54+
3-In root frontend directory you should run your next project
3555
```bash
36-
npm install
37-
npm run dev
56+
yarn install
57+
yarn run dev
3858
```
3959

4060
## API Reference
@@ -60,7 +80,8 @@ This section tracks the progress of implemented features in project.
6080

6181
- [x] Add swagger to project.
6282
- [x] Add Next-auth to project -> frontend directory.
63-
- [ ] Add all api response states(success,failure).
83+
- [x] Add all api response states(success,failure).
84+
- [x] Dockerize project.
6485

6586
## Screenshots
6687

docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
services:
2+
# ⚠️Next auth error in login api handler. so i decided to comment it for now
23
# client:
34
# container_name: ngca_client
45
# build:

0 commit comments

Comments
 (0)