deadbaed / api.epi.today

api for epi.today

Home Page:https://api.epi.today

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

api.epi.today

Rust Docker Hub

This is a rewrite of a my project epi.today in the effort of separating the back-end from the front-end.

It's my first project in rust, so if you find bad code that could be rewritten don't hesitate to open an issue!

development

Run cargo build to compile the project.

You can run the debug version of the project with cargo run.

The listening port is 4242.

⚠️ Warning: The server listens on http only, which means that zero bytes will be encrypted!
There is confidential data that will be transferred between the client and the server, please keep security in mind when deploying.

deployment

binary

Run cargo build --release to compile the project ready to be released.

The binary will be available in ./target/release/api-epi-today.

docker

When building the Dockerfile, the server is compiled with the musl library and statically linked, in order to make the server portable and keeping the Docker image small.

The docker image is available on Docker Hub (please don't use the one in the GitHub registry).

Start the server in a container as a daemon with docker run -d --restart unless-stopped --name api-epi-today x4m3/api-epi-today.

Stop the container with docker stop api-epi-today.

About

api for epi.today

https://api.epi.today


Languages

Language:Rust 99.4%Language:Dockerfile 0.6%