Skip to content
An API used to manage information in a Security Operations Center (SOC)
TypeScript Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
src Merge branch 'master' of https://github.com/JunquerGJ/Atlas Nov 30, 2019
.dockerignore - Moved entities to one folder for transpile microservice. Nov 29, 2019
.env
.gitignore Added .idea folder to .gitignore. Nov 29, 2019
.gitlab-ci.yml Migration from Gitlab Nov 28, 2019
.mocharc.json Migration from Gitlab Nov 28, 2019
Dockerfile - Moved entities to one folder for transpile microservice. Nov 29, 2019
LICENSE Initial commit Nov 28, 2019
README.md Migration from Gitlab Nov 28, 2019
api.yaml Migration from Gitlab Nov 28, 2019
knex.js Migration from Gitlab Nov 28, 2019
package-lock.json Merge remote-tracking branch 'origin/hackathon-jiraintegration' into … Nov 29, 2019
package.json - Moved entities to one folder for transpile microservice. Nov 29, 2019
test.pdf Migration from Gitlab Nov 28, 2019
tsconfig.json
tslint.json Migration from Gitlab Nov 28, 2019

README.md

Atlas

An API used to manage information in a Security Operations Center (SOC).

Pre-requisites

You must have one database tool like PostgreSQL installed on your machine to turn on Atlas application.

  1. Install PostgreSQL or another BBDD tool.
  2. Create a database on the tool.
  3. Check that the database is working properly.

Getting started

Installing dependencies

First of all, you need to download gitlab repository and install all the dependencies with by typing the command below:

npm install

Development server

Configure database connection

At the first time, you must configure the connection to the database in the file .env at the root path.

An example of configuration to connect to a PostgreSQL database:

DB_USER=postgresql          
DB_PORT=5432 // Database port on your machine
DB_HOST=localhost                   
DB_PASSWORD=postgresql              
DB_DATABASE=database_name_example  
PORT=5000   // Microservice port to start server
JWT_SECRET=WhateverStringYouWantBecauseIsOnDevelopment

Start server

Run the command below:

npm run dev

This will create all the database tables if is the first time and start the development server on port.

You can’t perform that action at this time.