Skip to content

Commit fa2981f

Browse files
committed
Refactor documentation and add more information
1 parent 3849ed1 commit fa2981f

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Entain test task
22

3+
### Tools and technologies used:
4+
5+
1. Go
6+
2. PostgreSQL
7+
3. Docker
8+
4. Makefile
9+
5. Postman
10+
311
All database tables are in `migrations` folder. To run them, use `make` command.
412

513
1. `make migrate-up` - to run up migrations
@@ -43,7 +51,7 @@ Postman collection is in `postman` folder to test endpoints.
4351
1. Create `.env` file in root folder and add all required variables from `.env.example` file
4452
2. To run migrations you should have migrate tool installed. You can install it with `brew install golang-migrate` (https://github.com/golang-migrate/migrate/tree/master/cmd/migrate)
4553
3. To run any `make` command you should have `make` tool installed. You can install it with `sudo apt install make` command (https://linuxhint.com/install-make-ubuntu/)
46-
4. Run `make migrate-up` command to run migrations and create all tables with test user (user_id: 63e83104-b9a7-4fec-929e-9d08cae3f9b9)
54+
4. Run `make migrate-up` command to run migrations and create all tables with test user (user_id: `63e83104-b9a7-4fec-929e-9d08cae3f9b9`)
4755
5. Run `make run` command to run application
4856
6. Take a look at `postman` folder to take collection for testing all endpoints
4957

@@ -53,6 +61,6 @@ This user has 50 amount of his balance for testing.
5361
## To run application in docker container:
5462

5563
1. Create `.env` file in root folder and add all required variables from `.env.example` file
56-
2. To run docker container you should have `docker` and `docker-compose` tools installed (Tested on docker version 20.10.22, build 3a2c30b and docker-compose version 1.26.2, build eefe0d31)
64+
2. To run docker container you should have `docker` and `docker-compose` tools installed (Tested on `docker version 20.10.22, build 3a2c30b` and `docker-compose version 1.26.2, build eefe0d31`)
5765
3. `docker-compose up` - to run application in docker container
5866
4. `docker-compose down` - to stop application in docker container

0 commit comments

Comments
 (0)