Skip to content
This repository has been archived by the owner on Jun 18, 2023. It is now read-only.

Latest commit

 

History

History
19 lines (16 loc) · 785 Bytes

local.md

File metadata and controls

19 lines (16 loc) · 785 Bytes

Run cmpct.io locally

It is pretty easy to get cmpct.io running, please get in touch if you have any trouble.

Pre-requisites

  • You need a few things on your machine to work with cmpct.io
  1. Git - To clone and work with branches
  2. Fork of this repo - So you can submit PR's
  3. NodeJS - Version 14
  4. yarn - To install packages and run the website
  5. IDE - Any modern IDE should be fine, we use vscode

Run the website

  • With the code open in your IDE, open a terminal and run the following commands
  1. yarn - To install the dependencies
  2. yarn dev - To start the website
  3. Now you can visit the website, hosted at localhost:3000

Notes

  • When you run the website locally you will not be hooked up to the API, a local instance needs to be stood up.