rster2002 / Ledgero-API

Work in progress backend for managing personal finance.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ledgero API

This repository contains the back-end code for the personal finance application I'm working on.

Development

To start developing for this repository, follow these steps:

  1. Clone the repository.

  2. Make sure you've installed the Rust toolchain.

  3. Install the sqlx-cli using cargo.

  4. Generate a key file for the JWT signatures using:

    ssh-keygen -t rsa -b 4096 -m PEM -f jwtRS256.key
  5. Make sure you're running a Postgres database (you can use the docker-compose.yaml for this)

  6. Create an .env file using the .env.example file and update the values accordingly.

  7. Create the database using:

    sqlx database create
  8. Make sure to run the migrations during development using:

    sqlx migrate run
  9. Start the application using:

    cargo run

Creating a docker image

The application is build into a docker image for development of the Ledgero-UI and for deploying to production. To build a docker image, run the build-images.sh script.

Deploying

Deploying a production build is done using the docker image:

  1. First, make sure the Postgres database is up.
  2. Create an .env file using the .env.example file and update the values accordingly.
  3. Pull and run the docker image. The application will automatically run all required migrations on the database.

About

Work in progress backend for managing personal finance.

License:GNU Affero General Public License v3.0


Languages

Language:Rust 99.8%Language:Dockerfile 0.2%Language:Shell 0.1%