https://github.com/nachotoast/foundationx-api

Bots, web server, and other backend functionality for the FoundationX server network.
https://github.com/nachotoast/foundationx-api

discord discordjs express expressjs mongodb node nodejs openapi typescript

Last synced: about 2 months ago
JSON representation

Bots, web server, and other backend functionality for the FoundationX server network.

• Host: GitHub
• URL: https://github.com/nachotoast/foundationx-api
• Owner: NachoToast
• License: mit
• Created: 2023-10-12T02:35:07.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-12T18:54:03.000Z (3 months ago)
• Last Synced: 2024-10-17T00:51:20.430Z (2 months ago)
• Topics: discord, discordjs, express, expressjs, mongodb, node, nodejs, openapi, typescript
• Language: TypeScript
• Homepage: https://api.foundationxservers.com
• Size: 524 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        

# FoundationX-API

Various Discord bots and related functionality for the [FoundationX](https://foundationxservers.com) server network.



## Table of Contents

- [Table of Contents](#table-of-contents)

- [Repository Structure](#repository-structure)

- [Installation](#installation)

## Repository Structure

This application consists of 2 main components, **modules** and **services**.

**Modules** are segments of functionality, they don't interact with each other and can be run in isolation from other modules. These include our main Discord bot (`mainBot`), server-stats-displaying Discord bots (`serverStatsBots`), and our front-facing web API (`webApi`).

**Services** are more specific portions of functionality. Similarly to modules, they do not interact with other services. However modules may interact with services. These include Discord OAuth (`discordAuth`), server stats collection (`serverStats`), and user information retrieval (`userInfo`).

## Installation

_TBD_

Main bot needs the following:

- scopes: `bot`, `applications.commands`

- permissions: `Manage Roles`, `Send Messages` `Embed Links` 

OAuth needs the following:

- scopes: `identify`, `connections`