diff --git a/client/package.json b/client/package.json index 25d1d3c..c3765e2 100644 --- a/client/package.json +++ b/client/package.json @@ -1,6 +1,6 @@ { "name": "knowledge-client", - "version": "0.0.0", + "version": "0.1.0", "private": true, "engines": { "node": ">=8" @@ -18,7 +18,6 @@ "@zeit/next-css": "^1.0.1", "antd": "^3.12.3", "delay": "^4.1.0", - "express": "^4.16.4", "firebase": "~5.7.1", "is": "^3.3.0", "is-email-like": "^1.0.0", diff --git a/mvp.md b/docs/mvp.md similarity index 100% rename from mvp.md rename to docs/mvp.md diff --git a/package.json b/package.json index 3387d62..d7cefa0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "knowledge", - "version": "0.0.0", + "version": "0.1.0", "private": true, "scripts": { "dev:client": "cd client && npm run dev", diff --git a/readme.md b/readme.md index b3686f3..d644e97 100644 --- a/readme.md +++ b/readme.md @@ -1,13 +1,20 @@ # Knowledge -> Knowledge is a Q&A-style app +> A better way to get answers to your questions -_Developed during the Chingu Voyage-7 cohort by Bears Team 22. Read more about Chingu and future cohorts [here](https://chingu.io)._ +_Developed during the Chingu Voyage-7 cohort by bears team 22. Read more about Chingu [here](https://chingu.io)._ + +
+
+ + + +
## MVP -See [the MVP spec](mvp.md). +See [the MVP spec](docs/mvp.md). ## Development @@ -20,6 +27,31 @@ Then, run `npm run dev` to start the app in development mode or `npm start` to r See our backend API documentation [here](https://rawcdn.githack.com/chingu-voyage7/Bears-Team-22/a666ca417134b6b29758eb851f257af446b78d61/docs/index.html). +### Technical Stack + +Both our frontend and backend are written in Node.js. The tech stack consists of 3 main components: + +#### Frontend + +- [React.js](https://reactjs.org) +- [Ant Design](https://ant.design/) - React UI components library. +- [Next.js](https://nextjs.org) - for SSR and building/starting the app. + +#### Backend + +- [Express.js](https://expressjs.com) - for the main API which servers the frontend app. +- [MongoDB](https://www.mongodb.com) - for data storage. +- [Firebase Auth](https://firebase.google.com/docs/auth) - for password-based user authentication + +### DevOps and deployment + +- [Docker](https://www.docker.com) - for deploying our backend and frontend as containers. +- [Docker Compose](https://docs.docker.com/compose) - for locally running the backend app and Mongo. +- [Heroku](https://www.heroku.com) - for deploying the frontend. +- [AWS](https://aws.amazon.com/) - to deploy the project's backend. The main AWS services we're using are EC2, ECS, Fargate, CloudFormation and [CDK](https://github.com/awslabs/aws-cdk). +- [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) - for deploying Mongo to the cloud. + +We're also using [various libraries and modules](https://github.com/chingu-voyage7/Bears-Team-22/network/dependencies). ## Creators @@ -29,6 +61,7 @@ See our backend API documentation [here](https://rawcdn.githack.com/chingu-voyag - [George Keloglou](https://github.com/geokeloglou) - [Vincent Tang](https://github.com/vincentntang) + ## License MIT diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..3aac86b Binary files /dev/null and b/screenshot.png differ diff --git a/server/cloud/package.json b/server/cloud/package.json index c6a1ec4..63d12b0 100644 --- a/server/cloud/package.json +++ b/server/cloud/package.json @@ -1,6 +1,6 @@ { "name": "knowledge-aws", - "version": "0.0.0", + "version": "0.1.0", "private": true, "bin": { "aws": "bin/aws.js" diff --git a/server/package.json b/server/package.json index 4b3f52e..e8aac84 100644 --- a/server/package.json +++ b/server/package.json @@ -1,6 +1,6 @@ { "name": "knowledge-server", - "version": "0.0.0", + "version": "0.1.0", "private": true, "main": "index.js", "engines": {