Skip to content
This repository has been archived by the owner on Feb 1, 2021. It is now read-only.

Latest commit

 

History

History
73 lines (45 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

73 lines (45 loc) · 2.08 KB
Raw

Contributing

Applications

client

The client of Bundle Analyzer, available in production on https://app.bundle-analyzer.com.

A static application deployed automatically by Netlify.

server

The server of Bundle Analyzer, available in production on https://api.bundle-analyzer.com.

A Node.js application deployed automatically by Heroku.

docs

The docs of Bundle Analyzer, available in production on https://docs.bundle-analyzer.com.

A static application deployed automatically by Netlify.

Setup project

Requirements

Getting Started

  1. Be sure to use the correct Node.js version specified in .nvmrc.
  2. Install dependencies at the root of the repository: yarn.
  3. Setup environment variables:
  • Copy apps/client/example.env to .env and fill the values (available in OnePassword).
  • Copy apps/server/example.env to .env and fill the values (available in OnePassword).
  1. Start database and RabbitMQ, at the root of the repository: docker-compose up -d.
  2. Initialize the database, at the root of the repository: yarn setup.
  3. Run the project in development: yarn dev.
  • The app is available at http://localhost:8080
  • The API is available at http://localhost:3000
  • A GraphQL Playground is available at http://localhost:3000/graphql
  • A RabbitMQ interface is available at http://localhost:15672 (guest / guest)

Database

Create a new migration

To create a new migration, run the following command at the root of the repository:

yarn workspace server knex migrate:make <name-of-migration>

Run migrations

To run migrations, run the following command at the root of the repository:

yarn workspace server db:migrate

Reset database

To reset database, run the following command at the root of the repository:

yarn workspace server db:reset