0t4u / nyananime-backend

Nyan Anime (Back-end)

Description

This is a back-end for Nyan Anime written with Typescript.

Stack

Frameworks: Express
Databases: MySQL, Redis
Other: Docker

Docker Hint

Building is done with docker-compose build.
Running is done with docker-compose up.
Shutting down is with docker-compose down.

CLI Commands

Command	Description
yarn dev	Starts the backend in developer mode.
yarn serve	Starts the backend in production mode.
yarn pretty	Formats the codebase using Prettify.
yarn lint	Runs ESlint linter on the codebase.
yarn linty	Automatically lints the codebase using ESlint.
yarn typecheck	Runs Typescript checker on the codebase.

Contributing

If you want a feature added or you found a bug, make a new Issue.
If you want to contribute, make a new Pull Request.
There are no guidelines or any of the sort and contributing is highly encougaraged!

License

Nyan Anime (Back-end) is licensed under the GNU General Public License v3.0.