Important

This repository represents the official and authorized version of the original Kenko API source code. The project was previously published without authorization and under an incorrect license. For full license terms, see the LICENSE file. All prior distributions should be considered incorrect and legally void. If you have obtained this code from another source under different terms, please refer to this repository as the canonical source of truth.

Kenko API

This is an official repository containing source code of the Kenko mobile app's API.

It's written in Rust using Axum web framework, SQLx as database driver, PostgreSQL for database, and Redis for caching.

Documentation

This project was never intended to be made public therefore it lacks any code documentation and comments.

However you can find documentation of the API routes and usage on Postman.

Building

To build the API you're expected to have some basic knowledge of how Rust, Axum, Postgres, and REST APIs work.

1. Generate asymmetric key pair for JWT signing/verification

./keys/generate.sh

2. Copy .env.example to .env and change the DATABASE_URL to your Postgres credentials

3. Point redis_url in config.toml to your running Redis instance

4. Execute all migrations (in order) from ./migrations/ directory

5. Run the development server

cargo run

6. Build the API for production

cargo build --release

License

This project is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).

You can read more in LICENSE file.