GDAds/API
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
An ad-serving API for GDAds
6 commits 1 branch 0 tags 89 KiB
JavaScript 100%
Go to file
KontrollFreek 95b06faa94 cleaner code
2024-03-31 05:00:40 -04:00
route/v1 cleaner code 2024-03-31 05:00:40 -04:00
.example.env base API 2024-03-28 23:20:40 -04:00
.gitignore fix gitignore 2024-03-31 04:43:55 -04:00
index.js rename images to uploads 2024-03-31 04:41:34 -04:00
LICENSE Initial commit 2024-03-26 22:44:47 +01:00
package.json image serving + upload remuxing/converting 2024-03-31 04:39:04 -04:00
README.md image serving + upload remuxing/converting 2024-03-31 04:39:04 -04:00
yarn.lock image serving + upload remuxing/converting 2024-03-31 04:39:04 -04:00

README.md

GDAds API

An ad-serving API for GDAds.

What is this?

GDAds as a whole is a service intended for content creators and gd players alike. This API acts as way to interact with our servers to serve ads on any connected website or other platform.

This API is designed to be as well documented as possible to aid in developing for platforms unconsidered in this project.

Feel free to read the wiki to learn more.

How do I run my own instance?

While I question why you want to, follow the steps below.

  1. Clone the repo and navigate to your cloned repository.

  2. Install all required dependencies using yarn (also works with npm install, pnpm, etc.).

    • You will also need FFmpeg for remuxing uploaded videos.

  3. Fill out all required information in a .env file.

    • .example.env contains all the needed information to run the server, and you can leave most values as the default. Just make sure to rename the file to .env.

    • This requires hosting a MongoDB instance. If you don't have one, visit MongoDB Atlas for a free one or host your own.

  4. Run the instance with node .

    • In order to properly access this instance outside of your network, you will need to set up various other services. If you need help with this, a more detailed guide can be found in wiki: Networking.