Skip to content
Knowledge: A better way to get answers to your questions
JavaScript CSS TypeScript Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client
docs
server
.editorconfig
.gitattributes
.gitignore
.npmrc
.travis.yml
heroku.yml
license
package.json
readme.md
screenshot.png

readme.md

Knowledge

A better way to get answers to your questions

Developed during the Chingu Voyage-7 cohort by bears team 22. Read more about Chingu here.


MVP

See the MVP spec.

Development

Getting started

First of all, obtain your Firebase SDK service account credentials (more info on this can be found in this guide). Rename server/sample.env to prod.env (keep it in the server directory), and replace the placeholders with your credentials.

Then, run npm run dev to start the app in development mode or npm start to run it in production mode. It should then be running on http://localhost:3000, with the backend API running on http://localhost:5000.

See our backend API documentation here.

Technical Stack

Both our frontend and backend are written in Node.js. The tech stack consists of 3 main components:

Frontend

Backend

DevOps and deployment

  • Docker - for deploying our backend and frontend as containers.
  • Docker Compose - for locally running the backend app and Mongo.
  • Heroku - for deploying the frontend.
  • AWS - to deploy the project's backend. The main AWS services we're using are EC2, ECS, Fargate, CloudFormation and CDK.
  • MongoDB Atlas - for deploying Mongo to the cloud.

We're also using various libraries and modules.

Creators

License

MIT

You can’t perform that action at this time.