Git Product home page Git Product logo

gedeair_backend's Introduction

Gedeair Backend

By Florian "FloRide" Reimat

About

This project is a backend for an RPG (Or in french JDR, thus the name) system.

Usage

Manual

You need to provide a PostgreSQL Database connection, using either Command Line Interface arguments, Environment Variable or load them through an .env file, every argument can be seen with the --help (-h short version) arguments, Some of the connection argument have default values, but you can override them with no worries. Here is an example of an .envfile with all connection values filled:

# DATABASE
# Either like this
POSTGRES_USER="gedeair_db_user"
POSTGRES_PASSWORD="my_secret_password"
POSTGRES_PORT=5432
POSTGRES_HOST="<gedeair_database_hostname>"

# Or like this (/!\ This one take priority)
DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}"

# OPENID
FRONTEND_BASE_URL="https://my_website_frontend_url.com"
BACKEND_BASE_URL="https://my_website_backend_url.com/with_its_endpoint"
OPENID_ISSUER="" # For Keycloak: "https://<my_keycloak_server>/realms/<my_realm>"
OPENID_CLIENT_ID="my_gedeair_client_id"
OPENID_CLIENT_SECRET=""

Run it

# Dependencies (Optional)
nix develop

cargo run --release
# or if you want to build
cargo build --release
./target/release/gedeair_backend

Docker

docker build -t <your-image-name> .

docker run <your-image-name>

Tip

You can also look at DockerHub for the official image:

tag Explanation
master The master branch of github (not safe)
latest The latest safest version (recommanded)
vX.X.X The image version

gedeair_backend's People

Contributors

floride1 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.