Supernova

Table of Contents

• Introduction
• Technology
  • Background
• Getting Started
  • Running Development Server
  • Running Tests

Introduction

Supernova digitizes what today is done with excel sheets.

Backgroud

Even nowadays, many companies still rely on old technologies in order to store their call center, technical assistance, and field work information. Most of these companies use excel sheets. Therefore, there is a big oppoturnity to digitalize their information and help them to have a better managment of their processes.

Technology

• Docker and Docker Compose to create our development and test environments.
• CircleCI as a general CI.
• Postgres to store our data and Sequelize as a Node.js ORM.
• Ava as a framework for tests.
• Yarn as a package manager.

Getting Started

To get started, you should install Docker and Docker Compose.

Then, clone the repository:

$ git clone [email protected]:black-atom/supernova.git

There are 3 default .env files. You can change them according to your needs..

Setup

To setup the environment you can change or create a .env file. Then run:

make database
make run-test-migration
make run-seeds

Running Server

To run locally, simply do the following command:

make server

This will start the development server listening on port 3000.

Running Tests

To run our tests, do:

$ make test

This will run both e2e and unit tests

Create Migrations

node_modules/.bin/sequelize migration:generate --name migration_name