Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
charafzellou committed Jul 7, 2023
1 parent 4a6cd3c commit 3e2ae5c
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,32 @@ Build a service that :
The original assignement document can be viewed [here](./docs/ASSIGNEMENT.md).

## Usage :
### Using `Make` :
Using `Make`, you can execute the following commands :
### Using `Docker-compose` :
Using `Docker-compose`, you can execute the following commands :

```bash
make install
make start
docker-compose up -d
```


### Using Go locally :
- Using a local install of Go, you can execute the following commands :

```bash
source .env
cd src
go build . -o app
./app
cp .env.dist .env
```

- Set up your Environement Variables, then :

```bash
cd app/indexer
go build . -o indexer
./indexer
```
```bash
cd app/api
go build . -o api
./api
```

## Checklist :
Expand Down Expand Up @@ -57,4 +66,4 @@ go build . -o app
- [X] The sender’s address is the delegator.
- [X] The delegations must be listed most recent first.
- [X] The endpoint takes one optional query parameter `year` , which is specified in the format `YYYY` and will result in the data being filtered for that year only.
- [ ] Ensure the service is production-ready, considering factors like performance, scalability, error handling, and reliability.
- [ ] Ensure the service is production-ready, considering factors like performance, scalability, error handling, and reliability.

0 comments on commit 3e2ae5c

Please sign in to comment.