I have never met a man so ignorant that I couldn't learn something from him. ~ Galileo

galileo

Made using hapi.js, the repository uses mysql database.

How to Run?

How to setup on Linux or Mac

git clone http://github.com/navgurukul/galileo
cd galileo

Installation

npm install -g gulp@3.9.0
npm install -g typescript
npm install -g typings (required for setup)
npm install yarn (required for installing dev-dependencies)
yarn install (install dependencies and dev-dependencies from package.json)
npm run setup (install nuget packages & typings)

Configuration

export GALILEO_ENV='dev'
cp src/configurations/sample-config.json src/configurations/config.dev.json
Edit the contents of src/configurations/config.dev.json to suit your configuration
git clone https://github.com/navgurukul/newton
mv newton curriculum

DB SETUP

Create a database, add the access credentials of the database to your config file
Import schema.sql to import the database schema
bash courseUpdate.sh all to import all the courses to your local database

Run

gulp build (build ts files)
gulp tslint (run tslint)
gulp watch (watch ts files)
npm run start (start the application)
npm run watch (restart the application when files change)

How to setup on windows

git clone http://github.com/navgurukul/galileo
cd galileo

Installation

npm install -g typescript
npm install -g ts-node (required to run typescript)
npm install -g typings (required for setup)
npm install yarn (required for installing dev-dependencies)
yarn install (install dependencies and dev-dependencies from package.json)
npm run setup (install nuget packages & typings)
Install python and setup it's enviroment variable for pip and python3(pip is installed along with python3, ).
pip install awscli (required aws sdk)

Configuration

Add enviroment variable GALILEO_ENV = 'dev' on windows.
cp src/configurations/sample-config.json src/configurations/config.dev.json.
Get seprate AWS keyId and Secret Key to send email and upload images.
Get Google Authentication keyId and secretKeyId.
Edit the contents of src/configurations/config.dev.json to suit your configuration.
git clone https://github.com/navgurukul/newton
mv newton curriculum (renaming the content folder).
aws configure (to setup aws-sdk provide the keyId, SecretKey and region which has access to upload images to AWS).

DB SETUP

download mysql from https://www.mysql.com/products/workbench/.
Create a database davinci, add the access credentials of the database to your config file.
Import schema.sql to import the database schema.
bash courseUpdateWindows.sh all in git Bash to import all the courses to your local database.

Run

npx gulp build (build ts files and run linter)
npx gulp tslint (run tslint)
npx gulp watch (watch ts files)
npm run start (start the application)
npm run watch (restart the application when files change)

Extra Configuration

Add facilitator emails in json file to assign each courses to the facilitator.
bash courseUpdateWindows.sh all in git Bash to import update all the courses with facilitator email Id.

Documentation

When the code is running, documentation is accessible at localhost:5000/docs.

Our Git Workflow

Main Branches

master is our holy grail. master and only master will ever be deployed to production environment.
dev is our playground (after we have perfected our code). dev will always be pushed to the staging environment.

Workflow

All the development will take place in issue/feature specific branches. When starting a new branch, pull the new branch from master branch which will have the most stable code. You can do it from dev for the time being if the master is not upto date.
Create a pull request from the issue specific branch into dev which will be approved by someone who has the relevant access before being merged into dev.
After being merged into dev, we will deploy it to staging environment.

We will make sure to have frequent merges from dev into master and release stuff into production

Migrations

npx db-migrate up to upgrade migrations
npx db-migrate down to downgrade migrations
create database.json in the root folder with following the configurations

{
    "dev": {
            "host": "host",
            "user": "username",
            "password": "password",
            "database": "database-name",
            "driver": "mysql",
            "multipleStatements": true
        },
    "sql-file":true
}

npx db-migrate create <migrtaion_file_name> To create migrations in migrations folder there would be two files created one would contain the sql command to upgrade and one to downgrade

kashishkhullar/galileo