Skip to content

Getting started

Below are directions on how to get started building the Origin platform (including UI, backend, SDKs).

Before you can start Origin development, you need to go through basic installation and building process.

  1. Make sure you are using Node 14.x.x
  2. Make sure you have Java runtime installed in your system
  3. Install yarn package manager using npm i -g yarn
  4. Install rushjs (rushjs.io): npm install -g @microsoft/rush
  5. Origin requires PostgreSQL database installed and configured
  6. Clone Origin repository branch master
  7. Copy .env.example to .env (default values are for now)
  8. Install packages using rush update command
  9. Build using rush build command

Note

We recommend using Docker for all external services, databases etc, please follow (requires psql command line tool installed): 

docker pull postgres
docker run --name origin-postgres -e POSTGRES_PASSWORD=postgres -d -p 5432:5432 postgres
psql -h localhost -p 5432 -U postgres -c "CREATE DATABASE origin"