Epicentre

Cloud Monitoring and Deployment Tool built by SIESGSTarena Platform Team

About The Project

Roadmap (Contributions Encouraged!)

• To work on adding other cloud service providers like Amazon Web Services (AWS) and Google Cloud Platform (GCP)
• Providing integration other VCS providers like GitLab and BitBucket
• Adding more CI service providers like Circle CI, etc.
• Adding more information and management options in existing system.

How Can You Contribute?

Read the Contributing Guidelines to know how easy it is to contribute to this project!

Usage

Setting Up Actions

• GitHub
  • Create an Access Token for your GitHub Account with all permissions (Reference)
• Travis CI
  • Create an API Token for your Travis CI account with all permissions (Reference)
• Heroku
  • Generate a Heroku Token from account settings page or create a new one from CLI (Reference)

Setting Up Security Keys For Authentication

• Copy this file and update the configurations in your new .env file
• Update the new .env with your data for the project
• Create a Firebase Project and make sure you have following things set up:
  • Enable Public Read/Write for your Firebase Storage (Reference)
  • Enable Public Read/Write for your Firebase Realtime Database (Reference)
  • Create a new Firebase Storage Bucket
  • Create a new Private Key by visiting the Project Settings Page > Service Accounts.
• Create a new folder keys inside config to save encryption keys (Note: file names should be exactly same)
  • keys/private.key - Private Key generated from any online service
  • keys/public.key - Public Key generated from any online service
  • serviceAccount.json - Private Key generated from Firebase Console

Install the NPM dependencies

npm install

Run the server

npm start
npm run dev

(Development) Testing and Fixing Code Quality

npm run lint
npm run fix

(Development) Run tests

We will add unit tests soon. Testing will be done via Travis CI

npm run test

Architecture

License

Copyright 2019 SIESGSTarena

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.