Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coasterfreakde/isekaibackend

A backend for the Isekai Discord Bot and AnimeDatabase Website
https://github.com/coasterfreakde/isekaibackend

anime database isekai

Last synced: about 2 months ago
JSON representation

A backend for the Isekai Discord Bot and AnimeDatabase Website

Awesome Lists containing this project

README

        


IsekaiBackend


A backend for the Isekai Discord Bot and AnimeDatabase Website






-----

## 📝 Table of Contents

- [About](#about)
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)


## 🧐 About

This is the backend for the Isekai Discord Bot and Website. It is written in Kotlin and uses the Javalin Framework.


## 🏁 Getting Started

### Prerequisites

- [Gradle](https://gradle.org/)
- [Java 17](https://www.oracle.com/java/technologies/downloads/#java17)
- [MongoDB](https://www.mongodb.com/)

### Installing

1. Clone the repository
2. Run `gradle build`
3. Run `gradle shadowJar`
4. Copy the `.env.example` file and rename it to `.env`
5. Fill in the `.env` file
6. Run the jar file
7. Open the website
8. Done!


## 🎈 Usage

### Running the jar file

```shell
java -jar IsekaiBackend.jar
```

### Connect via REST

```shell
curl -X GET http://localhost:8080/
```


## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check the issues page.


## 📝 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details


## 📧 Contact

If you have any questions about the project, feel free to contact me via [Discord](https://discord.gg/pixelplayland).