README.md

A source code management monitoring system written in NodeJS.

Documentation

https://mozillasecurity.github.io/argus

This app follows the MEVN stack.

Client WebApp

Prerequisites

Redis and MongoDB are required.

brew install redis mongodb

Setup Prerequisites

redis-sever
mongodb --dbpath=/tmp/

Setup

npm install

Development

Development mode does support hot reloading through Webpack middleware.

npm run development

API

Type	Path	Description
POST	/signin	Retrieving the JWT
GET	/api/v1/repos/	Get a list of repositories
POST	/api/v1/repos	Add a repository
GET	/api/v1/repos/:id	Get commits
DELETE	/api/v1/repos/:id	Delete a repository
PUT	/api/v1/repos/:id	Force pulling a repository

The x-access-token header needs to be set in order to make a request to any API path. The JWT token can be obtained during the signin process.

Testing and Coverage

npm test

NOTE: Before each commit npm test is run to prevent any potentially test failure and style issues from being accidentally pushed.

Tests are written with the assertion library ChaiJS running with the MochaJS test framework.

npm run coverage