Backend Blog Bot Example Commands

This project is an API designed to store example bot commands for Discord. It is implemented with a focus on security, simplicity, and a scalable architecture.

Features

• Secure Authentication: Authentication system based on JWT (JSON Web Tokens) with additional security measures.
• Granular Permissions: Detailed access control, allowing specific permissions to be assigned to users for different actions within the API.
• Unit Tests: The project includes unit tests for critical functions, ensuring their proper operation and preventing future errors.
• Focus on Security: Implementation of basic security measures such as protection against CSRF, XSS attacks, and IP-based access restrictions.
• Clear Documentation: Each endpoint and functionality is well-documented, with usage examples and possible errors.

Controllers

You can find the documentation for each controller in the following files:

• Auth Controller
• Users Controller
• Roles Controller
• Posts Controller

Installation

Step 1: Clone this repository

git clone git@github.com:HormigaDev/backend-blog-botcommands.git

Step 2: Enter the project directory and install dependencies

cd backend-blog-botcommands/
npm install

Step 3: Configure your .env file, and if you are using the r-backups CLI, also configure the .r-backups file (The example content is in .env.template and .r-backups.template)

Step 4: Test or run the project

npm run test

or

npm run dev