Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reiosantos/tembea

express javascript maps nodejs slack slack-api tembea

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/reiosantos/tembea
Owner: reiosantos
Created: 2019-11-05T16:45:43.000Z (about 5 years ago)
Default Branch: develop
Last Pushed: 2022-12-22T12:58:57.000Z (about 2 years ago)
Last Synced: 2023-03-02T18:35:52.507Z (almost 2 years ago)
Topics: express, javascript, maps, nodejs, slack, slack-api, tembea
Language: JavaScript
Size: 8.48 MB
Stars: 1
Watchers: 2
Forks: 3
Open Issues: 31
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # tembea

[![CircleCI](https://circleci.com/gh/andela/tembea.svg?style=svg)](https://circleci.com/gh/andela/tembea)

[![Maintainability](https://api.codeclimate.com/v1/badges/2c9375e12e9652a7ec9f/maintainability)](https://codeclimate.com/repos/5bf472b3752a29565a00c791/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/2c9375e12e9652a7ec9f/test_coverage)](https://codeclimate.com/repos/5bf472b3752a29565a00c791/test_coverage)

Trip management at it's best for Andela.

## Description

**Tembea** is the our solution for making trip request, scheduling, reporting and analytics very easy at Andela.

## Table of Contents

- [tembea](#tembea)

  - [Description](#description)

  - [Table of Contents](#table-of-contents)

  - [Documentation](#documentation)

  - [Setup](#setup)

    - [Dependencies](#dependencies)

    - [Getting Started](#getting-started)

      - [Database and ORM](#database-and-orm)

    - [More about environmental variables](#more-about-environmental-variables)

    - [Run the Service Using Docker](#run-the-service-using-docker)

  - [Testing](#testing)

  - [Deployment](#deployment)

  - [Docker for Local development](#docker-for-local-development)

## Documentation

`/api/v1/slack` : our slack integration is our MVP

## Setup

### Dependencies

- [NodeJS](https://github.com/nodejs/node) - A JavaScript runtime environment

- [Express](https://github.com/expressjs/express) - A web application framework for NodeJS

- [PostgreSQL](https://github.com/postgres/postgres) - A relational database management system that extends SQL

- [Sequelize](https://github.com/sequelize/sequelize) - A promise-based ORM for NodeJS

### Getting Started

Follow these steps to set up the project in development mode

- Install [Nodejs](https://nodejs.org/en/download/)

- Install and setup [PostgreSQL](https://www.postgresql.org/)

- Clone the repository by running the command

  ```[bash]

  git clone https://github.com/andela/tembea.git

  ```

- Run `cd tembea` to enter the application's directory

- Install the application's dependencies by running the command

  ```

  yarn install

  ```

- Create the `.env` or `.env.development` file by running `cp .env.sample .env` or `cp .env .env.development`

- Populate the env file created above by obtaining valid values for the environment variables. (Consult your teammates).

- Setup the database and migrations (**_see [database setup](#database-and-orm, 'setting up database')_**)

- Start the application by running

  ```

  yarn run start:dev

  ```

  The application should now be running at `http://127.0.0.1:5000`

#### Database and ORM

- Create a database in `PostgreSQL` and name it `tembea`

- Set the following environment variables in `.env` (to be created in the `env` directory):

  - `DATABASE_USERNAME` - this is the database username

  - `DATABASE_PASSWORD` - this is the database password. Ignore if you don't have a database password

  - `DATABASE_NAME` - set this to `tembea`

- Run database migrations

  ```

  yarn run db:migrate

  ```

- Check the database and confirm that the `users` table has been created

### More about environmental variables

After setting up your `.env` from the template provided in the `env/.env.sample` file;

to use these environment variables anywhere in the app, simply:

```[js]

process.env.MY_ENV_VARIABLE

```

### Run the Service Using Docker

> NOTE: Make sure no service is running on port 5000 and ensure there is a `.env` file with all the necessary environment variables.

To run the application just type: `make start`

this would run your application inside a container which you can easily access using `localhost:5000`.

To stop the application, you can just hit `^c`.

To delete the containers: `make stop`

> WARNING: Running below command will make you loose all your data including data in the database!

To cleanup all the containers + volumes: `make clean`

> NOTE: The below commands should be run when the application is running inside container

To migrate database: `make migrate`

To seed database: `make seed`

To rollback migrations: `make rollback`

To get inside the container: `make ssh`

HINT: To use docker, ensure that your .env file does not contain `DATABASE_URL` as it conflicts with the value in `docker-compose.yml`

## Testing

[Jest](https://jestjs.io) is used as the testing framework for both the unit tests and integration tests.

To execute all tests, run the command

```

  yarn test or make test

```

## Deployment

TODO - add deployment commands

## Docker for Local development