SwitchSpace-Frontend application can be found here

There might be some minor changes between the API documentation and the latest version of the project.

The API documentation can be found here.

Both for the back end and front end application check

• nodejs official website - nodejs includes npm (node package manager)

Just for the backend application:

• mongodb official installation guide

Go to your project root folder via command line

cd path/to/workspace/SwitchSpace-Backend

Install node dependencies

npm install

Set up your database

• Create a new directory where your database will be stored (it's a good idea to separate data and business logic - the data directory should be on a different place than your app)
• Start the database server

mongod --dbpath relative/path/to/database

Development environment

-Start DB server

sudo systemctl start mongod

-Add seed data from seeds folder

Install mongo seeds globally

npm install -g node-mongo-seeds

Run seed

seed

Create index on the seeded items in the db (optional: it should be created automatically)

use switch_space

db.posts.createIndex({exchangeLocation:"2dsphere"})

-Start dev server

npm run devstart

Production environment

npm start

Enviroment specifications

you will need the following variables in your env file

• for server tokens and the specific port to run the server on

  • PORT=
  • JWT_SECRET

• Your DB URL

  • MONGODB_URI=

• media server (S3 object storage)

  • AWS_ACCESS_KEY_ID=
  • AWS_SECRET_KEY=

• Payment

  • STRIPE_PAYMENT

Deployment on GCP

If you intend to use Kubernetes in GCP

• create GKE cluster and open cloud shell

• copy your .env file to the server

• create a secret from your env file (myenv is the name of the secret)

  kubectl create secret generic myenv --from-env-file=.env

• copy deployment.yml and service.yml to the cluster and run the following:

  kubectl apply -f deployment.yml

  kubectl apply -f service.yml

• apply variables from your secret to the deployment:

  kubectl set env --from=secret/myenv deployment/switchspace-server

you're done! :)

other helpful commands:

• Kubernetes cluster operate on the below mentioned ports,
  • 30000-32767 (node port range)
  • 8001, 443, 6443 (for Kubernetes communication )
• kubectl set env -h
• kubectl set env pods --all --list
• kubectl get pods --all-namespaces
• kubectl get deployments --all-namespaces
• kubectl get services --all-namespaces
• kubectl scale deployment <deployment_name> --replicas=<replicaNumber>

Helpful References:

• https://www.docker.com/sites/default/files/d8/2019-09/docker-cheat-sheet.pdf
• https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets
• https://cloud.google.com/kubernetes-engine/docs/concepts/secret#from_files
• https://medium.com/@tszumowski/how-to-inject-environment-variables-into-kubernetes-pods-after-deployment-489306fff1a8