This document describes how to set up your development environment to run and test Connectify.
It also explains the basic mechanics of using git, node.
- Prerequisite Software
- Getting the Sources
- Installing NPM Modules
- Spinnng up the Database
- Setting up environment variables
- Starting the server
Before you can run and test Connectify, you must install and configure the following products on your development machine:
- Git and/or the GitHub app (for Mac or Windows); GitHub's Guide to Installing Git is a good source of information.
- Node.js, (version specified in the engines field of
package.json) which is used to run a development web server, run tests, and generate distributable files. - Firebase which is used as a NoSQL database.
Fork and clone the repository:
- Login to your GitHub account or create one by following the instructions given here.
- Fork the main repository.
- Clone your fork of the repository and define an
upstreamremote pointing back to the Connectify repository that you forked in the first place.
# Clone your GitHub repository:
git clone [email protected]:<github username>/Connectify.git
# Go to the Connectify directory:
cd Connectify
# Add the main repository as an upstream remote to your repository:
git remote add upstream https://github.com/vrushti-mody/Connectify.gitNext, install the JavaScript modules needed to build and test Connectify:
# Install project dependencies (package.json)
npm ciMail to us for access to the firebase console
You need to set up the Firebase Credentials here
cp .env.template .envnpm start