Archived

This repository has been archived on 2024-12-31. You can view files and clone it, but cannot push or open issues or pull requests.

Mathias Wagner bb78376745 Added the Sheepstar API to the Archive

2022-09-06 16:37:56 +02:00

1.0 KiB

Raw Blame History

Sheepstar API

About The Project

This is the official Sheepstar API. It was written with javascript and made to run with express. Have fun during programming :p

Getting Started

Prerequisites

Before you start you need to download npm

npm install npm@latest -g

Installation

Clone the repo

git clone https://github.com/sheepstar-dc/SheepstarAPI.git

Install NPM packages as dev
```
npm install --save-dev
```

Create a .dotenv file and replace it to your needs

# DATABASE
MYSQL_HOSTNAME=localhost
MYSQL_USERNAME=username
MYSQL_PASSWORD=password
MYSQL_DATABASE=database
# EXPRESS
SERVER_PORT=3000
# CDN
CDN_MEDIA_PATH=/home/user/uploads
# BOT
CLIENT_SECRET=discord_oauth_client_secret
CLIENT_ID=discord_client_id
REDIRECT_URI=discord_oauth_redirect_uri

Start the dev server
```
npm dev
```

Contributing

You can contribute by creating a pull request. We'll check it and merge it then

1.0 KiB Raw Blame History