Welcome to the loremaster-backend wiki!

This application is primarily written in JS, with many frameworks including GraphQL, NodeJS, express, and others. This wiki will primarily illustrate the current capabilities that exist in the api. All planned features can be found on the project board in the main organization.

Basic installation

To begin start by cloning the repository and entering the main directory.

$ git clone https://github.com/HeadassHouse/loremaster-backend.git
$ cd loremaster-backend

Next run npm install to download all of the packages in the project

$ npm install

Note after running this, there may be an error with bcrypt that requires the running of the following command:

$ npm install node-pre-gyp -g

Configuring the DB

This can be found here

Starting the project

The project will begin running on port 4000

$ npm start 

Now navigate to http://localhost:4000/graphql to get started