Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.16 KB

README.md

File metadata and controls

51 lines (34 loc) · 1.16 KB
Raw
corum

An open, democratic & self governing forum.

corum screenshot

Corum's API Codebase

Visit the corum-api repo.

Usage

IMPORTANT

Before running either the development or the production server, it is important that a Corum API instance has been created, and a .env file has been created in the root of the project with the following environment variables:

  • API_ENDPOINT (String) - The graphcool endpoint for Corum's API.
  • PROD (Boolean) - Determines what error messages and logging should occur.

An example .env file can be found at .env.example.

If you do not know how to setup a Corum API, head over to the following github repo, corum-api.

Development

To start the development server, run the following commands:

yarn
yarn dev

To view the site, navigate to http://localhost:3000 in your browser.

Production

To start the production server, run the following commands:

yarn
yarn deploy