https://github.com/rsource-open-source/rsource-records
📊 The rsource Discord bot. An advanced interface for viewing community times.
https://github.com/rsource-open-source/rsource-records
detritus discord discord-bot nodejs strafesnet typescript
Last synced: 4 months ago
JSON representation
📊 The rsource Discord bot. An advanced interface for viewing community times.
- Host: GitHub
- URL: https://github.com/rsource-open-source/rsource-records
- Owner: rsource-open-source
- License: afl-3.0
- Created: 2021-06-08T01:44:51.000Z (about 4 years ago)
- Default Branch: dev
- Last Pushed: 2023-03-06T19:58:46.000Z (over 2 years ago)
- Last Synced: 2025-01-02T23:41:58.356Z (5 months ago)
- Topics: detritus, discord, discord-bot, nodejs, strafesnet, typescript
- Language: TypeScript
- Homepage: https://rsource.community/records
- Size: 399 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
```
__
______________ __ _______________ ________ _________ _________/ /____
/ ___/ ___/ __ \/ / / / ___/ ___/ _ \ / ___/ _ \/ ___/ __ \/ ___/ __ / ___/
/ / (__ ) /_/ / /_/ / / / /__/ __/ / / / __/ /__/ /_/ / / / /_/ (__ )
/_/ /____/\____/\__,_/_/ \___/\___/ /_/ \___/\___/\____/_/ \__,_/____/
```
# rsource-records
[](https://www.codefactor.io/repository/github/rsource-open-source/rsource-records)
## Technologies:
[](https://www.typescriptlang.org/) [](https://nodejs.org/) [](https://www.npmjs.com/package/detritus-client) [](https://webassembly.org/) [](http://www.ffmpeg.org/) [](https://prisma.io/)
[](https://www.oracle.com/cloud/) [](https://ubuntu.com/)
[](https://www.digitalocean.com/products/managed-databases) [](https://postgres.org/)
## About
rsource-records is a TypeScript written Discord bot that uses the [detritus library](https://github.com/detritusjs/client) to interact with the Discord API. This bot is made to fetch content from the Roblox Bhop & Surf games via the [StrafesNET API](https://api.strafes.net/). This aims to be a bot that has many more features than just an API fetcher in the future.
**_This is still in its early development phase._**
Note: this project uses multiple branches, each are titled for their purpose. The project structure follows a production branch, developemnt bramch, and sub-dev branch; `main`, `dev`, and `dev/*`, where `*` represents any.
[Project Board](https://github.com/orgs/rsource-open-source/projects/1)
Shortlink for this repository: https://rsource.rqft.space/records/
## Setup
### Services
\*not in use yet
Requirements:
- [Node](https://nodejs.org/) v16 LTS
- [Git](https://git-scm.com/)
- [Prisma](https://prisma.io/)\*
- [PostgreSQL](https://postgresql.org/)\*
What we use (optional services):
- Code editor/IDE: [VSCode](https://code.visualstudio.com/)
- Code loader: [nodemon](https://nodemon.io/)
### Setting up
Creating a local copy of this repository and running:
```bash
git clone https://github.com/rsource-open-source/rsource-records.git # creates repository locally
cd rsource-records
```
Now that we have the repository on our machine, let's populate it.
```bash
npm i # installs all dependencies
code .env # assuming you use vscode
```
Populate the `.env` and the `config.json` file with the applicable interfaces [here](https://github.com/rsource-open-source/rsource-records/blob/main/src/interfaces.ts) and the [.env.example](https://github.com/rsource-open-source/rsource-records/blob/main/.env.example) file.
After that, we can compile and run the code, here, we use nodemon to run out code everytime we save a file, **if you don't want to use nodemon** run the according:
```bash
tsc # compiles OR npm run build
# create a split/seperate terminal
node dist
```
Else:
```bash
tsc -w # compiles and watches for saves
# create a split/seperate terminal
nodemon dist
```
This isn't required, but it is encouraged to clean up the throwaway files.
```bash
rm .env.example
```