Architecture

The CBO provides an efficient API for interacting with listings, services and organizations in our graph database.

Schema

SSN for organization uses the same schema and architecture as SS service. See full details here

SSN FOR ORG API

A Graphql API is exposed here, and from here you can interact and see the schema along with documentation.

Technology Stack

We majorly use GRANDstack and a mixture of other tools listed below:

• Programming Language: JavaScript

• Frameworks: Nodejs, Express, Apollo, Graphql, React

• Core Database: Neo4j, MongoDb

• In-memory Cache: Redis

Devops and Hosting

SSN Org API hosting

The CBO API is hosted on Heroku under the pipeline name ssn-for-organization. We have two hosted instances for both staging and production environment.

• Staging: The staging environment is hosted under the name ssn-for-orgs-staging It is directly linked to the dev branch on the GitHub repository. Heroku CI/CD has been configured to automatically run tests and deploy a new version to staging on every push to dev branch.

• Production: The production environment is hosted under the name ssn-for-orgs-prod

Note: Since we expose a graphql server as, you can access the staging graphql server here and for production here

Development environment setup

For developers, to set up a local environment, follow the steps below:

• Ensure you have Nodejs (v12 and above), Yarn and Git installed.

• Clone the repository:

git clone https://github.com/PhilanthroLab/ssn-for-orgs

• Cd into project folder and Install packages using yarn.

cd ssn-for-orgs
yarn 

• Get your .env file from your tech lead and add to your project folder.

• Start the application locally:

yarn start

We may use postman for interacting and testing some part of CBO API. Go to the Philanthrolab team workspace on postman to interact with your local instance.