Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.11 KB

README.md

File metadata and controls

45 lines (34 loc) · 1.11 KB

Scrounch Backend

By Florian 'FloRide' Reimat

About

This project is a backend API built using Rust with the Axum web framework, designed to handle operations for an e-commerce-like platform. The core functionalities include product management (CRUD operations), file handling, and caching, making it efficient and scalable for a variety of use cases

Usage

Manual

# Dependencies (Optional)
nix develop

# Setup example env
mv .env.prod.example .env

cargo run --release
# or if you want to build the exec
cargo build --release

# You can find the exec in the <project_dir>/target/release/scrounch_backend

Nix

# Setup example env
mv .env.prod.example .env

nix build

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 (recommended)
vX.X.X The image version