📋
Philanthrolab
  • Philanthrolab Technical Docs
  • SSN Component Library
  • Datalabs
    • Introduction
    • Architecture
    • Schema Dictionary
    • Project Status/Timeline
  • Social Safety Network
    • Introduction
    • Architecture
    • Schema Dictionary
    • Project Status/Timeline
      • V1
      • V2
  • SSN for Organisations
    • Introduction
    • Features and user stories
    • Architecture
    • Schema Dictionary
    • Project Status/Timeline
  • Developer Resources
    • Frontend Project Guide
    • Coding Guide
    • Creating a Neo4j instance on GCP vm
    • Set up local deploy for staging and production envs
    • Install ElasticSearch on GCP
    • ElasticSearch Query
    • ETL Strategy for Neo4j Database: Scraping, Transformation, and Enrichment
    • ETL Checklist
  • SSN Authentication
    • Introduction
    • Architecture
    • Schema
  • SSN Admin Dashboard
    • Introduction
    • Architecture
  • SSN Job Board
    • Introduction
    • Architecture
    • User Stories
    • Schema Dictionary
  • SSN Eligibility criteria AI feature
    • Introduction
    • Working Principles
    • Architecture
    • Schema Dictionary
  • DataBase Repopulation
    • Introduction
    • Proposed Solution
    • DB Details
    • Batch 1
  • LLM INTEGRATION
    • LLM Strategy and Implementation
Powered by GitBook
On this page
  • Schema
  • SSN FOR ORG API
  • Technology Stack
  • Devops and Hosting
  • Development environment setup

Was this helpful?

  1. SSN for Organisations

Architecture

PreviousFeatures and user storiesNextSchema Dictionary

Last updated 3 years ago

Was this helpful?

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

SSN FOR ORG API

A Graphql API is exposed , 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. 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

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

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

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

here
here
ssn-for-organization
here
team workspace