A very random collection of services, packed into a RESTful Rust api. https://fej.roosens.me
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Jef Roosens d8b0d35c40 Merge pull request 'Update dependency eslint to v8' (#94) from renovate/eslint-8.x into develop 11 months ago
.hooks [#26] Moved all routing to server binary 2 years ago
benches [#13] Further overhaul of the project structure for better testing 2 years ago
docker Merge pull request 'Update node Docker tag to v17' (#97) from renovate/node-17.x into develop 11 months ago
migrations Added backend linting job 2 years ago
src Fixed faulty import line 2 years ago
web Update dependency eslint to v8 11 months ago
.dockerignore [#44] [#44] Release container now builds & packages frontend as well 2 years ago
.editorconfig Added .editorconfig file 2 years ago
.env [#24] Initialized diesel project 2 years ago
.gitignore Added cargo init 2 years ago
.woodpecker.yml Fixed faulty import line 2 years ago
Cargo.lock Update Rust crate diesel to 1.4.8 11 months ago
Cargo.toml Update Rust crate diesel to 1.4.8 11 months ago
LICENSE [closes #20] Switched to AGPLv3 2 years ago
README.md [#26] Updated README again 2 years ago
Rocket.toml [closes #33] Added compose file; ./fejctl rr works now 2 years ago
diesel.toml [#28] Switched search_streets to database 2 years ago
fejctl [#44] Fej can now easily startup a Vite development server 2 years ago
renovate.json Add renovate.json 2 years ago
roadmap.md [#26] Updated roadmap.md 2 years ago

README.md

Fej

Fej is a RESTful API that does lots of different things. It started as an experiment to learn Rust, but has grown into a full-on passion project.

Project Structure

The src folder contains subfolders for the various binaries and the main library, called fej. The biggest binary is called server, which is the binary that actually runs the Rocket.rs web server. All the others are utility programs, mostly consisting of scrapers for various services.

Version 1.1 also introduces the use of a database, namely PostgreSQL 13.

Roadmap

See roadmap.md.

Development

To make development more consistent (and keep my computer a bit cleaner) I've decided to run the entire toolchain using Docker, with Alpine Linux base images. This also allows me to make really small final images. Technically, Docker is the only dependency you need to contribute to this project (not accounting for language servers etc.).

A Bash script is provided to speed up development on the various binaries. It aids in starting up the containers, choosing which binary to run etc. A quick rundown of its most important features:

# By default, it compiles the 'server' binary (but doesn't run it)
./fejctl

# The first argument is the action you wish to perform, the second on which
# binary (not all commands need a binary as input, so they just ignore it)
# For example, this will run the binary called server
./fejctl r server

# This runs the tests (all commands also have their full name if you want)
./fejctl t
./fejctl test

# These attach to the two containers
./fejctl sh   # Opens a new root shell inside the 'fej' container
./fejctl psql # Open a new psql shell in the fej database

Docker images

The images are available here.