Skip to content
/ api Public

An average fart collector API.

Notifications You must be signed in to change notification settings

FartMapHQ/api

Repository files navigation

FartMap API

An API used to store and retrieve farts for the FartMap app.

Currently a work in progress, please come back later !

Deploy

Note that you should keep the processing-uploads and uploads directories in the root of the project, as they are used to store the uploaded files. When you want to reset the database, you can delete all the files in the directories but keep the directories themselves.

Also, you must have ffmpeg installed on your system to process the uploaded files.

Using Docker Compose

Make sure to have docker and docker-compose installed. Configure your environment variables in the docker-compose.yml file. Finally, run docker-compose up -d --build and you'll have the server running on port 8024.

Using a service

Run bun run build:bin and you'll have a bin executable in the root of the project.

Running this executable will start the server on port 8024. You can use whatever you want to run this binary in the background, like systemd (an example service is available at fartmap-api.service that you can copy into /etc/systemd/system and enable using systemctl enable --now fartmap-api).

About

An average fart collector API.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published