-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,104 +1 @@ | ||
| # Ketsuna (Back/Front) | ||
|
|
||
| This is the full back-end and front-end of Ketsuna. It is a REST API built with [Node.js](https://nodejs.org/en/) and [Fastify](https://www.fastify.io/). It also contains a [Discord bot](https://discord.com/developers/docs/intro) that is used to communicate with the Discord API. | ||
| The Front-end is built with [React](https://reactjs.org/) and [Next.js](https://nextjs.org/). | ||
|
|
||
| ## Features | ||
|
|
||
| - [x] Discord bot | ||
| - [x] REST API | ||
| - [x] Front-end | ||
| - [ ] Database | ||
| - [ ] Docker support | ||
|
|
||
| ## Requirements | ||
|
|
||
| - [Node.js](https://nodejs.org/en/) (v20.0.0 or higher) | ||
| - [Prisma](https://www.prisma.io/) (v3.0.0 or higher) | ||
| - [PNPM](https://pnpm.io/) (v6.0.0 or higher) | ||
|
|
||
| ## Installation | ||
|
|
||
| 1. Clone the repository | ||
| 2. Install the dependencies with `pnpm install` | ||
| 3. Create a `.env` file in the root directory and fill it with the following variables: | ||
|
|
||
| ```env | ||
| # The port the server will listen on | ||
| PORT=3000 | ||
| # The Discord bot token | ||
| DISCORD_TOKEN= | ||
| # Config the Discord Status | ||
| DISCORD_STATUS_NAME=The best Bot ever | ||
| DISCORD_STATUS_STATE=The Best AI Bot | ||
| ``` | ||
| test | ||
| 4. Run the database migrations with `pnpm migrate` (this will create the database tables) | ||
| 5. Build the project with `pnpm build` | ||
| 6. Run the project with `pnpm start` or `node dist/main.js` or with pm2 `pm2 start npm --name "your-app-name" -- start` | ||
|
|
||
| ## Updating | ||
|
|
||
| 1. Pull the repository with `git pull` | ||
| 2. Install the dependencies with `pnpm install` | ||
| 3. Run the database migrations with `pnpm migrate` | ||
| 4. Build the project with `pnpm build` | ||
| 5. Restart the project with `pm2 restart your-app-name` | ||
|
|
||
| Or if you don't want to "build" the project : | ||
|
|
||
| 1. Change the branch to `prod` with `git checkout prod` | ||
| 2. Same as above but without the `pnpm build` step | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Discord bot | ||
|
|
||
| The Discord bot is used to communicate with the Discord API. It currently has the following commands: | ||
| /ai imagine `text` `[nsfw]` (Used to determine if it's NSFW or not, don't work outside of NSFW channels) `model` (The model to use, default is `deliberate`) `negative_prompt` (The prompt to filter what you don't want) | ||
| /ia login (Used to login to the AI Horde API, you need to have an account on the [AI Horde](https://stablehorde.net/) website) | ||
|
|
||
| ### Website | ||
|
|
||
| The website is used to interact with the Discord bot. It currently has the following pages: | ||
| / (The home page) | ||
| /cgu (The CGU page) | ||
| /privacy (The TOS page) | ||
|
|
||
| ## Contributing | ||
|
|
||
| Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. | ||
|
|
||
| ## Contributors | ||
|
|
||
| - [garder500](https://github.com/garder500) - creator and maintainer | ||
| - [trail-l31](https://github.com/trail-l31) - contributor | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT License](https://opensource.org/license/mit/) | ||
|
|
||
| ``` | ||
| MIT License | ||
| ----------- | ||
| © 2023 Jeremy S. | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| ``` | ||
| oui |