Contributing

Developer Quick Start

Make sure you have Node installed. LTE is recommended and currently serving Roost purposes.
The supported package manager and scripting tool for Roost is Yarn. This is our preferred package manager; if you choose to use npm please know you have signed up to maintaining a new part of this doc 😀.

$ cp .env.local.template .env.dev
$ vi .env.dev # insert your API key

yarn install
yarn dev

We use several technologies to improve our ability to deliver a solid experience. These tools have been listed below:

React: Allows us to develop component-based UI that can be reusable and use state efficiently. Also enables server-side rendering solutions and is the default framework for NextJS
Material UI: Provides a large set of layout, interaction, and content components to improve developer velocity

NextJS: a relatively new build utility that focuses on generating server-side content. NextJS provides many options for efficient rendering and is well supported/updated.
Now.sh: Made by the same group as NextJS, Now provides a simple (and cheap) way to deploy a NextJS application. We get automatic PR-based previews and rapid deployments to a standard domain.

Jest: Jest is a widely-used framework for writing unit tests. It ships many valuable tools that empower developers to design and implement tests.
Testing Library (React): This is a set of simple tools to allow for test writing that is more clear and concise. This library is built off of a framework-agnostic API, allowing for testing flexibility.

Husky: This module provides easy handling and configuration of Git hooks, allowing the hooks to be integrated more closely with the project.
Lint Staged: A utility for applying lint rules only on the files that have been changed. This improves performance while also allowing us to configure different linters based on the file extension.
Commitlint: A simple utility that enforces strict style on the commit messages. This, coupled with the conventional commit configuration, allows us to enforce clarity, and leverage commit messages in the future for release notes.