Skip to content

Commit

Permalink
Release initial MVP (#54)
Browse files Browse the repository at this point in the history
  • Loading branch information
itaisteinherz authored Feb 5, 2019
1 parent 5ca6022 commit f4fc8f1
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 8 deletions.
3 changes: 1 addition & 2 deletions client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "knowledge-client",
"version": "0.0.0",
"version": "0.1.0",
"private": true,
"engines": {
"node": ">=8"
Expand All @@ -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",
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "knowledge",
"version": "0.0.0",
"version": "0.1.0",
"private": true,
"scripts": {
"dev:client": "cd client && npm run dev",
Expand Down
39 changes: 36 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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)._

<br>
<div align="center">
<a href="http://knowledge2019.herokuapp.com">
<img src="screenshot.png" width="661">
</a>
</div>


## MVP

See [the MVP spec](mvp.md).
See [the MVP spec](docs/mvp.md).


## Development
Expand All @@ -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

Expand All @@ -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
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion server/cloud/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "knowledge-aws",
"version": "0.0.0",
"version": "0.1.0",
"private": true,
"bin": {
"aws": "bin/aws.js"
Expand Down
2 changes: 1 addition & 1 deletion server/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "knowledge-server",
"version": "0.0.0",
"version": "0.1.0",
"private": true,
"main": "index.js",
"engines": {
Expand Down

0 comments on commit f4fc8f1

Please sign in to comment.