Skip to content

RINIYAProject/endpoint.riniya.uk

Repository files navigation

Banner Discord Ko-fi Mail Website

Documentations API Mail Website

This repo is still in work.

How do I use it?

It's very simple. All you need is git, a MongoDB server and Redis.

git clone git@github.com/RINIYAProject/endpoint.riniya.uk.git
cd endpoint.riniya.uk/
yarn && yarn run start

The .env is necessary to run the bot.

Required variables

# Database and pub/sub.
MONGODB_URL=mongodb://
REDIS_URL=redis://

# Websocket server to send the packets.
GATEWAY_URL=wss://gateway.riniya.uk

# Security
# Recommended to use specific domains.
CORS_ALLOWED_ORIGINS="*" 
CORS_ALLOWED_METHODS="GET,POST,PUT,PATCH,DELETE"

# Debugging and options
PORT=3500
DEBUG=true
ENVIRONEMENT=develop

# JWT Configurations
JWT_SECRET_KEY=

# Versioning
VERSION=1.0.1
REVISION=

# BCrypt and cookie safety
BCRYPT_SALT_ROUND=8
COOKIE_SESSION_SECRET=<super_secret_key>

# Discord application configuration
RINIYA_APP_IDENTIFIER=<bot-id>

Progression

  • Routes and controllers
  • Database models
  • Middlewares
  • Frontend client
  • Email templates
  • Controllers implementation
  • Files datastore system
  • MFA Authentication
  • Context menus

Advices

For the web apps you should use HAProxy to dispatch the network correctly. You should also use a separated server for the database, just for security reasons.

Disclaimers

This project is under the GNU-GPLv3 license. You must follow the license and guidelines to use this project. No commercial usage is allowed, You must upload your source publically under the same license and author. if you are using this project. You cannot remove the Author header / Contributor name inside the code. You cannot add you in the author list. You are only allowed to be in the contributor list if you did a pull request on the official repository.

Visitors:

visitors