kaomojidb API

Roadmap

click here to go to our roadmap on notion

Setup:

Click to expand!

To get the API up and running, there are many things to setup first,

Building from source:

Click to expand!

1. Once this repository is cloned and golang is installed in the system, navigate to this directory and run

go mod download

2. Once the dependencies are downloaded, using sample.env as reference either create a file called creds.env with the same keys or directly configure same keys as environment variables.
3. After the configuration and ensuring that the db is operational, run either

go build

to get the executable to run

or to build and run with a single command

go run app.go

MongoDB setup (local)

Click to expand!

You will need a mongoDB database, with atleast

• 1 user with credentials.
  • defaults: (API will use theese values by default)
    • username: root
    • password: example
• 1 database.
• at least a single role in the roles document.

Default recomended roles[ready to import]:

[{
  "_id": {
    "$oid": "626ad6e35204187f3579d44f"
  },
  "role": "admin",
  "level": 1,
  "permissons": {
    "readUsers": true,
    "usersAdmin": true,
    "readRoles": true,
    "rolesAdmin": false
  }
},{
  "_id": {
    "$oid": "626d011e9c6806ef1f5cddd5"
  },
  "role": "user",
  "level": 3,
  "permissons": {
    "readUsers": true,
    "usersAdmin": false,
    "readRoles": false,
    "rolesAdmin": false
  }
},{
  "_id": {
    "$oid": "626d01589c6806ef1f5cddd6"
  },
  "role": "root",
  "level": 0,
  "permissons": {
    "readUsers": true,
    "usersAdmin": true,
    "readRoles": true,
    "rolesAdmin": true
  }
},{
  "_id": {
    "$oid": "626d01cb9c6806ef1f5cddd7"
  },
  "role": "moderator",
  "level": 2,
  "permissons": {
    "readUsers": true,
    "usersAdmin": true,
    "readRoles": false,
    "rolesAdmin": false
  }
}]

Configuring local API

Click to expand!

Copy `sample.env` into `.env` and fill the `.env`

For local development if you are using the default you should be good to go by just filling:

• DB_1_NAME
• JWT_SECRET

DB_1_NAME being the database name, and JWT_SECRET a random string. This last one theoridically is not necessary, but is strongly recomended.

Configure OpenTelemetry (Optional)

Click to expand!

Open telemetry requires no etra configuration, but the data collector used does, in our case it is [LightStep](https://lightstep.com)

If you dont like this, dont fear, swaping this is actually very simple, since i have not integrated it 100%, and is only a few lines in ./src/main.go what you would have to remove/swap:

//Open Telemetry setup
 ls := launcher.ConfigureOpentelemetry(
 	launcher.WithServiceName("kaomoji-db"),
 	launcher.WithAccessToken(cfg.Config.OpenTel.LightStepKey),
 )
 defer ls.Shutdown()
 // END Open Telemetry setup

*This may not correspond 100% to reality

Contributing

If you wannt to contibute to the kaomoji-db api, please read the contributing gidelines