SD Jamaat Website

Current tooling:

• GatsbyJS & React
• Ant Design UI and Bootstrap
• Firebase Cloudstore as DB
• Firebase Cloud Functions

Local Development

Step 1: Clone the repository with Git

git clone https://github.com/sdjamaat/website.git sdjwebsite
cd sdjwebsite

Step 2: Download npm modules (NodeJS and Yarninstallation required).

yarn install

Warning: DO NOT use npm to do this - it will screw up the entire project. If you do accidently install using npm instead of yarn, delete your node_modules folder and also delete your package-lock.json file. Then follow the step listed above again.

Step 3: Run locally on live server

npm run dev
# then navigate to localhost:8000

Install new npm modules

Always use yarn to install new npm modules - otherwise, follow the warning message below if you accidently install with npm.

yarn add [some npm module]

Working with Firebase Functions

In this repository, there is a folder called functions which contains code related to Firebase cloud functions.

Step 1: Install the firebase-tools npm package globally

npm install -g firebase-tools

Step 2: Go into the functions directory. You will need to install dependencies here as well, however with npm this time instead of yarn

cd functions
npm install

To deploy new functions:

Helpful link: https://firebase.googleblog.com/2016/07/deploy-to-multiple-environments-with.html

Step 1: You need to first be log into the [email protected] Google account. You only need to do this once (unless you're switching between other Firebase accounts)

# this will open up a browser window where you'll need to login
firebase login

Step 2: Use this shell command to deploy the functions:

firebase deploy --only functions

Cohere Monitoring

Cohere is a monitoring platform that allows us to see in real-time how people are using the jamaat website and also allows us to control their screen if we need to. It is especially useful for helping out folks out who need assistance in navigating the jamaat website.

Cohere Dashboard: https://app.cohere.so/dashboard

In order to access the dashboard you must login with the [email protected] Google account. If you need access to this account, ask Ibrahim.