Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/molenzwiebel/oriannabot
:robot: Everyone's favorite Discord bot
https://github.com/molenzwiebel/oriannabot
champion-mastery discord-bot league-of-legends leagueoflegends mastery-bot orianna riot-games-api
Last synced: 5 days ago
JSON representation
:robot: Everyone's favorite Discord bot
- Host: GitHub
- URL: https://github.com/molenzwiebel/oriannabot
- Owner: molenzwiebel
- License: mit
- Created: 2017-04-20T19:40:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-16T00:15:47.000Z (18 days ago)
- Last Synced: 2024-12-22T18:11:57.367Z (12 days ago)
- Topics: champion-mastery, discord-bot, league-of-legends, leagueoflegends, mastery-bot, orianna, riot-games-api
- Language: TypeScript
- Size: 39.7 MB
- Stars: 120
- Watchers: 7
- Forks: 23
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Orianna Bot
[](https://discord.gg/bfxdsRC)
This is the source code for the Discord bot and website portions that compromise [Orianna Bot](https://orianna.molenzwiebel.xyz). Note that Orianna Bot is not intended for self-hosting (although it is theoretically possible), so if you want Orianna Bot on your Discord server the easiest solution is to simply press the large button [here](https://orianna.molenzwiebel.xyz).
# Components
This project consists of two components, creatively named frontend and backend. Frontend is a single-page app Vue.js application bundled by Webpack. Backend is both an express web server that powers the frontend, as well as an Eris Discord bot.
## Developing Frontend
To get started with developing on frontend, you'll need to install dependencies. First of all you need to have [Node.js](https://nodejs.org) installed and it should have version 10 or lower. In case if you already have Node.js installed and its version is higher than 10 [nvm](https://github.com/nvm-sh/nvm) is a good choice to reconsider. Then I recommend to get [yarn](https://yarnpkg.com) and simply run `yarn install` to install all dependencies.
`yarn watch` will start a hot-reloading webserver on `http://localhost:8081` which will automatically reflect your changes. Running `yarn bundle` will produce an optimized minified bundle that backend can find.
Note that you will have to potentially edit `frontend/src/config.ts` to point to an appropriate API endpoint. If you're only changing the frontend and not any backend related endpoints, you can just keep it as `https://orianna.molenzwiebel.xyz` (note that you might need a chrome extension or similar to work around CORS issues).
## Developing Backend
Again, install all Node-related dependencies with a simple `yarn install`. After that, copy over `config.json.template` to `config.json` and adjust all required values (surrounded by `<<>>`).
To create tables in the Postgres database, ensure that you have setup the config properly, then run `./node_modules/.bin/knex migrate:latest` to run migrations. You have to do this again every time there are new migrations.
If everything is setup correctly, running `yarn start` will compile the typescript sources and start the bot with the specified config values. Note that you may not see any output, since Orianna uses `debug` which displays nothing by default. To see all debug messages, set your `DEBUG` environment variable to `orianna*`.
If you are developing, you can use `yarn watch` to automatically compile typescript as you work. Note that if you make any changes to the translations, you will need to rebuild translations first. This can be done by simply running `build.js` in the translation folder.
# License
[MIT](http://opensource.org/licenses/MIT)