__
   ______________  __  _______________     ________  _________  _________/ /____
  / ___/ ___/ __ \/ / / / ___/ ___/ _ \   / ___/ _ \/ ___/ __ \/ ___/ __  / ___/
 / /  (__  ) /_/ / /_/ / /  / /__/  __/  / /  /  __/ /__/ /_/ / /  / /_/ (__  )
/_/  /____/\____/\__,_/_/   \___/\___/  /_/   \___/\___/\____/_/   \__,_/____/

rsource-records

Technologies:

About

rsource-records is a TypeScript written Discord bot that uses the detritus library to interact with the Discord API. This bot is made to fetch content from the Roblox Bhop & Surf games via the StrafesNET API. 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

Shortlink for this repository: https://rsource.rqft.space/records/

Setup

Services

*not in use yet

Requirements:

• Node v16 LTS
• Git
• Prisma*
• PostgreSQL*

What we use (optional services):

• Code editor/IDE: VSCode
• Code loader: nodemon

Setting up

Creating a local copy of this repository and running:

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.

npm i # installs all dependencies
code .env # assuming you use vscode

Populate the .env and the config.json file with the applicable interfaces here and the .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:

tsc # compiles OR npm run build
# create a split/seperate terminal
node dist

Else:

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.

rm .env.example