Skip to content

Latest commit

 

History

History
92 lines (57 loc) · 3.29 KB

README.md

File metadata and controls

92 lines (57 loc) · 3.29 KB
Raw

SikhiToTheMax's logo

SikhiToTheMax Website

Originally developed by SHARE Charity UK, SikhiToTheMax has become a defacto standard for Keertans and gurdwaras around the world to display Gurbani on screens for Sangat to join into the depth of Gurbani and translations.

SikhiToTheMax is now developed by Khalis Foundation as Seva to the Panth and Khalis Foundation is working hard to ensure it lives up to its name. Khalis Foundation Sevadaars are currently working hard to build newer version of SikhiToTheMax website using modern web technologies.

Website: http://www.SikhiToTheMax.org

Developer: Khalis Foundation and Sevadars (see committers for more details)

Acknowledgements: Bhai Tarsem Singh UK, SHARE UK, Khalis Foundation, Khalsa Foundation UK, Dr. Sant Singh Khalsa, Dr. Kulbir Singh Thind

Powered by

Build Instructions

Make sure you've git & nodejs installed in your system. We advise using Node version 8 or above, and npm version 5.7 or above.

Open terminal and follow these steps;

  • Step 1: Clone the repo.
git clone https://github.com/KhalisFoundation/sttm-web/

You should now see a SikhiToTheMax-Web folder in your present working directory. Let's change directory to it.

cd sttm-web/
  • Step 2: Install dependencies.
# `ci` doesn't update package.json, and uses package-lock.json to install intended deps.
# This makes it pretty speedy and doesn't cause unintended updates.
npm ci

This will use npm that is included with nodejs to install project dependencies.

  • Step 3: Start the project.

If you are running this project for the first time or did some change, run the following command to create a build and run it:

npm run dev

If you want to start a previous build, run the following command.

npm start

This will run a bunch of build tools and a nodejs server to deploy the code locally.

  • Step 4: Access your local dev environment of the SikhiToTheMax website
# On mac OS X
open http://localhost:8080
# On Linux
google-chrome http://localhost:8080
# On windows
start chrome http://localhost:8080
# Or just open chrome and enter the URL manually.

Contributing

Slack channel.

Before raising a pull request, please go through CONTRIBUTING.md. We use dev branch as the development branch, while master is the production branch. You should branch out from dev branch and raise a PR against dev branch. You can see your submitted changes on dev.sikhitothemax.org.

Project Overview

You can watch this project and code walkthrough.

Walkthrough.

License

GSL

All images and assets not covered under other licenses are covered under full Copyright © 2019 Khalis Foundation.

Site made reliable with help of BrowserStack