Code Monkey home page Code Monkey logo

server's Introduction

Server

Dependency Status Dependency Status

This is RD2L's backend and website.

Dependencies

Develop and run locally

  • nodejs
  • npm
  • postgres
  • redis

Run in Docker

  • docker

Installation

First, install the project's dependencies.

npm install

Next, get an api key from https://steamcommunity.com/dev/apikey. Either set this as an environment variable or a variable in a .env file - name must be STEAM_API_KEY.

Here's a template with example values for a complete .env file:

POSTGRES_USER='postgres'
POSTGRES_PASSWORD='postgres'
POSTGRES_DB='seal'
POSTGRES_HOST='localhost'
POSTGRES_PORT='5432'
REDIS_HOST='localhost'
REDIS_PORT='6379'
PORT='80'
HTTPS_PORT='443'
SECRET='random characters'
STEAM_API_KEY='get from https://steamcommunity.com/dev/apikey'

For HTTPS configuration, include the following entries:

SSL_KEY='path/to/key.pem'
SSL_CERT='path/to/cert.pem'
SSL_CA='path/to/ca.pem'

Steam bot support can be activated by providing the following:

STEAM_BOT_USERNAME='steam_username'
STEAM_BOT_PASSWORD='steam_password'

Auth requests can be forwarded by providing:

WEBSITE_URL='http://return-to-website.com'

Full database configuration can be configured using:

POSTGRES_USER='postgres'
POSTGRES_PASSWORD='postgres'
POSTGRES_DB='seal'
POSTGRES_HOST='localhost'
POSTGRES_PORT='5432'
POSTGRES_POOL_MAX='10'
POSTGRES_TIMEOUT='30000'

Running

To run locally:

npm start

To run in docker:

make build
make run

Running in docker requires environment variables, not .env variables. Additionally, and unsurprisingly, it requires docker to be installed and running.

server's People

Contributors

dambrisco avatar kabobrocks avatar kstigs avatar philkjacobs avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.