Skip to content

Commit c991a33

Browse files
committed
update doc
1 parent 38e27de commit c991a33

File tree

3 files changed

+10
-24
lines changed

3 files changed

+10
-24
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ build-go:
33
cd ./server && make build
44

55
run: build-go
6-
cd server/cmd && ./main & cd ../ui/ && yarn && yarn start
6+
cd server/cmd && ./main && cd ../../ui/ && yarn && yarn start
77

88
# Build images and run
99
docker-build:

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,28 @@ Download and install [golang](https://golang.org)
1313

1414
Download and install [postgres](https://www.postgresql.org/download/)
1515

16-
setup your postgres database, enter your config secrets in the [.env](./server/.env)
16+
Setup your postgres database, env secrets can be changed in the [.env](./server/.env) file
1717

1818
- [A complete guide to PostgreSQL](https://prabhupant.medium.com/a-complete-guide-to-postgresql-e4d1cefb9866)
1919

2020
- [Installing PostgreSQL for Mac, Linux, and Windows](https://medium.com/@dan.chiniara/installing-postgresql-for-windows-7ec8145698e3)
2121

22+
Ensure you have `make` installed.
23+
2224
```bash
23-
make build-go
25+
make run
2426
```
2527

26-
This will start the go server.
27-
28-
To start the react app navigate to the client directory
28+
This will start the go server & the react frontend.
2929

30-
```bash
31-
make build-go
32-
```
3330
### Using docker
34-
using docker compose
31+
Ensure you have `docker` installed
3532

3633
```bash
37-
docker-compose build
38-
docker-compose up
34+
make docker-build
35+
make docker-run
3936
```
40-
37+
Server is live on `:8081` and UI is on `:3000`
4138

4239
## Endpoints
4340
| endpoint | method | body | description |
@@ -51,6 +48,5 @@ docker-compose up
5148
## Contributing
5249
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
5350

54-
5551
## License
5652
[MIT](https://choosealicense.com/licenses/mit/)

node_modules/.yarn-integrity

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)