Sheepstar API

<h1 align="center">Sheepstar API</h1>

## 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
```sh
npm install npm@latest -g
 ```

### Installation

1. Clone the repo
   ```sh
   git clone https://github.com/sheepstar-dc/SheepstarAPI.git
   ```
2. Install NPM packages as dev
   ```sh
   npm install --save-dev
   ```
3. Create a `.dotenv` file and replace it to your needs
   ```dotenv
   # 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
   ```
4. Start the dev server
    ```sh
   npm dev
    ```
   
### Contributing
You can contribute by creating a pull request. We'll check it and merge it then