Skip to main content

Prerequisites

Before you try to run the project, please make sure to download and install the following:

With Docker Compose​

  1. Install Docker
  2. Install Docker Compose

You're all set 🎉🎉🎉.

Run docker-compose up to start the project

Without Docker Compose​

  1. Install Node.js
  2. Install Docker
    1. Install Docker Compose
  3. Install yarn. We use version 3.x currently.
    1. Specifically, make sure to set up vscode correctly.
  4. Install nvm
  5. Install watchman
  6. Allow execution of scripts in the db/ folder chmod +x db/*.sh. As always make sure to read scripts downloaded from strangers on the internet before executing them 😄

You're all set 🎉🎉🎉.

Run yarn install and yarn g:dev to start it up!

Windows​

  • When using Windows it is recommended to use WSL in order to avoid various issues. When using wsl for development, you may encounter issues accessing the web app via localhost. This issue should be fixed temporarily by restarting WSL with wsl --shutdown, and should be permanently fixed by turning off Windows 10 Fast Startup.