Skip to content

Commit e731ee6

Browse files
add flags in test (#26)
Signed-off-by: Thomas Poignant <[email protected]>
1 parent c989724 commit e731ee6

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

.github/workflows/ci-server.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ jobs:
6767
- name: Upload coverage reports to Codecov
6868
uses: codecov/codecov-action@v5
6969
with:
70+
flags: server
7071
fail_ci_if_error: true
7172
token: ${{ secrets.CODECOV_TOKEN }}
7273
env:

server/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# GO Feature Flag API - API to configure your feature flag
2+
![WIP](https://img.shields.io/badge/status-%E2%9A%A0%EF%B8%8FWIP-red)
3+
[![Build](https://github.com/go-feature-flag/flag-management/actions/workflows/ci.yaml/badge.svg)](https://github.com/go-feature-flag/app-api/actions/workflows/ci.yaml)
4+
[![codecov](https://codecov.io/github/go-feature-flag/app-api/graph/badge.svg?token=oqi5Ncgefx)](https://codecov.io/github/go-feature-flag/flag-management/)
5+
6+
This repository is a work in progress initiative to create an API to manage your feature flags.
7+
8+
## Goals
9+
- [x] Create an API to manage your feature flags
10+
- [ ] API should allow to add, modify and delete feature flags.
11+
- [x] Use a database to store the feature flags.
12+
- [ ] This API is created to integrate a front end application to manage the feature flags.
13+
- [ ] We should manage authentication and authorization to access the API.
14+
- [ ] Authentication should be generic enough to be integrated with any authentication provider.
15+
- [ ] We should be able to provide history of a flag to see when it was created, modified and deleted.
16+
17+
## Tech stack
18+
- GO API using echo
19+
- Postgres database using `sqlx` and `pq` as driver.
20+
21+
22+
## Contributing
23+
⚠️ Since this it is a work in progress initiative please come to the [Slack channel](https://gofeatureflag.org/slack) first before contributing.
24+
25+
### How to start the project.
26+
After cloning the project you can start the database _(using docker)_:
27+
```shell
28+
make setup-env
29+
```
30+
It will start an instance of postgres with the following credentials:
31+
- user: `goff-user`
32+
- password: `my-secret-pw`
33+
34+
And it will apply the database migrations to your environment.
35+
36+
To start the API:
37+
```shell
38+
make build
39+
./out/bin/goff-api
40+
```
41+
42+
When started you can access the swagger UI at [http://localhost:3001/swagger/](http://localhost:3001/swagger/).

0 commit comments

Comments
 (0)