https://github.com/vyzaldysanchez/guardrails-challenge

Docker/Node.js/React app challenge
https://github.com/vyzaldysanchez/guardrails-challenge

api express javascript nodejs react react-hooks redis rest-api testing

Last synced: 7 days ago
JSON representation

Docker/Node.js/React app challenge

• Host: GitHub
• URL: https://github.com/vyzaldysanchez/guardrails-challenge
• Owner: vyzaldysanchez
• Created: 2019-11-09T07:58:26.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T00:45:07.000Z (almost 2 years ago)
• Last Synced: 2023-02-28T02:52:18.203Z (over 1 year ago)
• Topics: api, express, javascript, nodejs, react, react-hooks, redis, rest-api, testing
• Language: CSS
• Homepage:
• Size: 2.5 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 40
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Guardrails Challenge

This represents the solution to the [GuardRails Challenge](https://github.com/guardrailsio/full-stack-engineer-challenge).

It consists of the following tech stack:

* A [docker](https://www.docker.com/get-started) setup to serve the application in multiple containers hoisting the different services we need

* A backend that exposes a REST API using `Node.js` with [Express](http://expressjs.com/). This API contains several services running inside of it and it's also connected to some services exposed in the docker environment:

  * [Redis](https://www.npmjs.com/package/redis) for caching purposes.

  * [PM2](https://pm2.keymetrics.io/) to handle clustering and auto-restart on failure.

  * [Compression](https://www.npmjs.com/package/compression) to increase response performance.

  * [Swagger](https://swagger.io/) for API documentation.

  * [Rate limiting](https://www.npmjs.com/package/express-rate-limit) to prevent issues with too many requests per second.

  * [Sentry](https://sentry.io/) to log system errors and keep track of them.

  * [Winston](https://www.npmjs.com/package/winston) to do logging.

  * [PostgreSQL](https://www.postgresql.org/) as DB and [Sequelize](http://docs.sequelizejs.com/manual/installation/getting-started) as abstraction.

  * [Mocha](http://mochajs.org/) + Node.js's [assert module](https://nodejs.org/api/assert.html) for testing.

* A frontend Dashboard built with [React](https://reactjs.org/) to display the data.

## API Description

The API exposes 3 necessary endpoints for this to work:

* `GET /scans-results` to get the list of all Security Scan Results.

* `GET /scans-results/{id}` to get a single Security Scan Result item.

* `POST /scans-results` to create Security Scan Result items into the database.

The API is available on `localhost:5000` in your local env after installing and running the containers.

The API documentation is exposed on `localhost:5000/api-docs` with [Swagger](https://swagger.io/).

## Dashboard Description

The frontend dashboard is built with [React](https://reactjs.org/) using the latest [React Hooks API](https://reactjs.org/docs/hooks-reference.html).

This dashboard consists of 3 pages:

* The home page, which displays a list of Security Scan Results.

* The `/scan-results/:id/findings` page, which displays the list of findings for a certain Security Scan Result.

* The `/create` page which displays a form in order to add Security Scan Results into the system.

After initializing the containers, the dashboard will be available on `http://localhost:3001/` in your local environment.

## Install instructions

First you should install [docker](https://www.docker.com/get-started) locally, this is due to the project running in a docker container. You won't need anything more, `docker` will download everything.

After installing docker, clone this repository. You'll notice an executable file `docker-challenge`, this file will help you running commands to specific containers.

You run `./docker-challenge up -d --build` to start running the container and all dependencies.

### DB Commands

* `./docker-challenge exec api npm run migrate` to run migrations.

* `./docker-challenge exec api npm run unmigrate` to revert migrations.

* `./docker-challenge exec api npm run generate-migration` to generate a migration file.

* `./docker-challenge exec api npm run sequelize` to run sequelize commands based on your needs.

## Running the server

* `./docker-challenge exec api npm run build` to transpile JS code to use ES6 in Node.js (no needed for dev).

* `./docker-challenge exec api npm run build:watch` to auto-generate the transpiled files on changes.

* `./docker-challenge exec api npm start` to run the server.

Notice that after starting the container, the server will be running already.

## To Take into Consideration

We are using [sequelize](http://docs.sequelizejs.com/manual/installation/getting-started) to manage DB operations.

## Coming soon

* Important frontend test coverage.