Skip to content

A REST API which provides you the information of any discord account including their Spotify & VS-Code activity!

License

Notifications You must be signed in to change notification settings

metaloozee/friday-api

Repository files navigation

Friday

A REST API which provides you the information of any discord account including their Spotify & VS-Code activity!

This is an open sourced repository initially made for educational purposes, we are using Discord.js & Fastify to make this, if you would like to collaborate or want to implement more things you are free to fork this repository and submit a Push Request when you feel you are good to go!

We also have a public API, if you'd like to use it then please join our support server in order to get access by clicking here.

Installing

In order to use Friday, you'd ideally need to install it on your local machine. To do so,

  • Clone the repository
git clone https://github.com/MetalOoze05/friday-api.git

Or if you have gh installed on your machine, you could instead run:

gh repo clone MetalOoze05/friday-api
  • Once cloned, switch directory and install dependencies:
cd friday-api
yarn install

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

TOKEN - Your Discord Bot token

GUILD_ID - The Server's ID in which you want to setup Friday

PORT - The port you want to run your server in. Defaults to 8080.

Once the environment variables are set, you're good to run Friday! To do so, run:

yarn dev

Thanks!

~ MetalOoze

About

A REST API which provides you the information of any discord account including their Spotify & VS-Code activity!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published