Skip to content

Commit 568f2ff

Browse files
Improve readme
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
1 parent 728a884 commit 568f2ff

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,28 @@ This repository is a work in progress initiative to create an API to manage your
1212
- Authentication should be generic enough to be integrated with any authentication provider.
1313
- We should be able to provide history of a flag to see when it was created, modified and deleted.
1414

15-
## Contributing
16-
Since this it is a work in progress initiative please come to the [Slack channel](https://gofeatureflag.org/slack) first before contributing.
15+
## Tech stack
16+
- GO API using echo
17+
- Postgres database using `sqlx` and `pq` as driver.
18+
19+
20+
21+
### Contributing
22+
Since this it is a work in progress initiative please come to the [Slack channel](https://gofeatureflag.org/slack) first before contributing.
23+
24+
### How to start the project.
25+
After cloning the project you can start the database _(using docker)_:
26+
```shell
27+
make setup-env
28+
```
29+
It will start an instance of postgres with the following credentials:
30+
- user: `goff-user`
31+
- password: `my-secret-pw`
32+
33+
And it will apply the database migrations to your environment.
34+
35+
To start the API:
36+
```shell
37+
make build
38+
./out/bin/goff-api
39+
```

0 commit comments

Comments
 (0)