Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.08 KB
Raw

Joist TS Contribution Guide

Thanks for your interest in contributing to Joist TS! We welcome contributions from the community and are happy to help you get started.

Getting Started

To get started, make sure you have all the prerequisites installed.

First Time Run Instruction

  1. Install dependencies: yarn
  2. Build Joist: yarn build
  3. Open Docker application
  4. Install docker image: yarn db

Consecutive Run Instruction

  1. Open Docker application (this is required for the database to run)

Prerequisites

Development Flow

It is recommended to run the built command in watch mode when developing locally. This will automatically rebuild the project when changes are made.

yarn build --watch

When updating migration files, you will need to run the db command to rebuild the database.

yarn db

To run the tests, run the following command:

yarn test