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

https://github.com/axorax/revlist-api

๐Ÿค– Backend, API and bot source code for Revlist
https://github.com/axorax/revlist-api

bot-listing relist revlist revolt revolt-bot revolt-bot-list revolt-chat

Last synced: 5 days ago
JSON representation

๐Ÿค– Backend, API and bot source code for Revlist

Awesome Lists containing this project

README

        

**`Revlist API`**

```
Host your own bot listing site!
```

## ๐Ÿ“– ยท Information

Backend code for Revlist. This contains all the data for Revlist and source code for the Revlist bot.

> [!IMPORTANT]
> **The Revlist API is not officially hosted.** You can self-host it.
>
> | Self-host | Type | Access |
> | --------- | -------- | ------------ |
> | API | Backend | Full control |
> | Website | Frontend | Only GET |
>
> The project's name was changed from "Revlist" to "Revlist" on 20 October 2024.
>

## โš’๏ธ ยท Self-hosting

1. Fork the repository

2. Clone it onto your PC

3. Open terminal in the root directory and run

```sh
npm install
```

4. Make a `.env` file with proper data as showed in `.env.example`

5. In terminal, run

```sh
node index.js
```

## ๐Ÿค ยท Contributing

You can contribute but it may take an indefinite amount of time for me to review and merge it as I have a lot of other stuff as well. Pull requests won't be accepted if its only a:

- Code refactor
- Useless change
- Contains NSFW content
- Decreases site accessibility
- Variable, class, id, etc. name change

## โค๏ธ ยท Supporting

Revlist is a hobby project. Any donations would mean a lot. You can donate via [Patreon](https://www.patreon.com/axorax) or for other mediums check [this repository](https://github.com/axorax/socials). You can also show support by starring ๐ŸŒŸ the repository.

---

Support me on Patreon โ€” Check out my socials