Giter VIP home page Giter VIP logo

project-hades's Introduction

Project Hades

The last event coordinator you will ever need

CodeFactor view docs view mobile app view web frontend Mailer service Permission generator


Directions to run

Get started with setting up Project Hades locally. This project uses GO111MODULE. To install dependencies run a go mod vendor after cloning.


Environment variables

These variables should reside as key value pairs in a file called .env.

Variable Name Description Data type
SALT Salt for hashing Integer
JWT_PASSWORD Password for JWT String
PROD_URI Neo4j URI String
MAIL_FROM Mailer email for analytics String
MAIL_TO Destination email for analytics String
MAIL_PASSWORD Password for MAIL_FROM String
NEO4J_AUTH Neo4j credentials String
MYSQL_ROOT_PASSWORD mysql root password String
MYSQL_PASSWORD mysql password String
MYSQL_USER mysql user String
SENDGRID_API_KEY SendGrid apikey String
FROM_EMAIL mailerQR from email String
BASE_URL Base URL of hades (http://[IP]/api/v1/) String

Production setup

Production setup uses performat dockerfiles made from scratch. It directly runs the compiled binaries.

To build binaries run

$ make # needs go installed
$ docker-compose -f performant-compose.yaml build
$ docker-compose -f performant-compose.yaml up -d neo4j
$ docker-compose -f performant-compose.yaml up -d

Dev setup

Dev setup compiles binaries on a heavier container runs them using watcher.

To run the setup simply do the following

$ docker-compose build 
$ docker-compose up -d neo4j
$ docker-compose up -d

Go to localhost:7474 to see if the database is running. You would have to create a new username and password the first time


Testing and documentation

To generate docs and testing, simply do the following

$ make docs
$ make test

project-hades's People

Contributors

ayushpriya10 avatar dependabot-preview[bot] avatar l04db4l4nc3r avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.