Skip to content

Y0ngg4n/fluffy_rest_api

Repository files navigation

Fluffy REST API

This is the REST API for the Fluffyboard Project.

Logo

Badges

Docker Cloud Automated build

Docker Cloud Build Status

Docker Pulls

Docker Image Size (latest by date)

Authors

Demo

You can test out a demo of the REST API here:

fluffy-board-rest-api.oblivioncoding.pro

⚠️ Warning this is the development REST API of fluffyboard.obco.pro ⚠️

Contributing

Contributions are always welcome!

Deployment

To deploy this project you can use the docker container on dockerhub:

yonggan/fluffy_rest_api

Checkout docker-compose.yml to spin up a instance with dockerized scylla-db.

Currently scylla-db is used without authentication and sharding.

Environment Variables

To run this project, you will need to add the following environment variables to your .env file or the docker-compose.yml

JWT_AUTH_SECRET: Set this secret for Json Web Tokens. It is recommended to change this.

SCYLLA_URI: Your database connection URI. When used with docker-compose you can change to scylla:9042

Roadmap

Checkout the Github Project

License

GNU General Public License v3.0