geokeloglou/bears-team-22

Knowledge is a Q&A-style app | Chingu Voyage-7

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

• React.js
• Ant Design - React UI components library.
• Next.js - for SSR and building/starting the app.

Backend

• Express.js - for the main API which servers the frontend app.
• MongoDB - for data storage.
• Firebase Auth - for password-based user authentication.

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

• Itai Steinherz
• Layer
• Stas Maksin
• George Keloglou
• Vincent Tang

License

MIT