Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thangtranse/coderschool-forum-app
Facebook news feed Application is project demo technical using the GraphQL with MongoDB.
https://github.com/thangtranse/coderschool-forum-app
docker docker-compose dockerfile graphql graphql-api graphql-client graphql-server material-ui mongodb mongoose nodejs reactjs redis
Last synced: 6 days ago
JSON representation
Facebook news feed Application is project demo technical using the GraphQL with MongoDB.
- Host: GitHub
- URL: https://github.com/thangtranse/coderschool-forum-app
- Owner: thangtranse
- License: mit
- Created: 2023-02-08T06:48:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-20T02:16:49.000Z (over 1 year ago)
- Last Synced: 2024-10-18T15:34:30.581Z (about 1 month ago)
- Topics: docker, docker-compose, dockerfile, graphql, graphql-api, graphql-client, graphql-server, material-ui, mongodb, mongoose, nodejs, reactjs, redis
- Language: JavaScript
- Homepage:
- Size: 598 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Coderschool Forum App
# Technology
**Node.js** uses an event-driven, non-blocking I/O model, which allows it to handle a large number of requests efficiently. This makes it well-suited for building high-performance web applications, such as discussion forums, where a large number of users may be concurrently posting and reading content.
**GraphQL** and **MongoDB** are good choices for building a discussion forum app because they offer several benefits:
1. GraphQL:
- Flexible data querying: GraphQL allows you to define exactly what data you need, reducing the amount of data transferred over the network and making it easier to fetch the exact data required for each component in your app.
- Efficient and fast: GraphQL can be faster and more efficient than REST APIs for certain types of applications, as it allows you to fetch all of the required data in a single request, rather than multiple requests.
- Strong type system: GraphQL has a strong type system that makes it easier to catch errors and ensure that your data is always valid.
- Easy to maintain: GraphQL makes it easy to evolve your API over time, as you can add new fields and types without breaking existing client code.
2. MongoDB:
- Document-oriented data storage: MongoDB is a document-oriented database, which makes it easy to store and retrieve semi-structured data, such as posts and comments in a discussion forum app.
- Scalability: MongoDB is designed to scale horizontally, allowing you to easily add more capacity as your discussion forum grows.
- High performance: MongoDB is designed to be fast and efficient, making it a good choice for storing and retrieving data in real-time.
- Flexible querying: MongoDB supports flexible and powerful querying, making it easy to retrieve data for your discussion forum app.
In conclusion, **GraphQL** and **MongoDB** are good choices for building a discussion forum app because they offer flexible, efficient, and scalable solutions for querying and storing data.
And here are the technologies I will use for this project:
1. NodeJS
2. GraphQL
3. MongoDb
4. Redis
5. ReactJS
6. Material-UI
# Data model
1. Accounts:
- email (String) - Required
- password (String) - Required
- name (String) - Optional
2. Posts:
- title (String) - Required
- content (String) - Optional
- author (Reference to Accounts) - Required
- tags (Array of Strings) - Optional
- upvotes (voteSchema) - Optional
- downvotes (voteSchema) - Optional
3. Comments:
- author (Reference to Accounts) - Required
- content (String) - Required
- post (Reference to Posts) - Required
- parentComment (Reference to Comments) - Optional
- childComments (Reference to Comments) - Optional
- upvotes (voteSchema) - Optional
- downvotes (voteSchema) - Optional
4. Hashtags:
- hashtag (String, Unit and ID) - Required
- post (Reference to Posts) - Required
voteSchema:
- users (Reference to Accounts) - Required
- count Number - Required
# Run App
First, you need to configure the `env` file.
1. Front-end
```env
PORT=3001
REACT_APP_GRAPH_QL_PATH=http://localhost:3000/graphql
```
2. Back-end
```env
PORT=3000
NODE_ENV=develop
MONGO_URL_CONNECT=
REDIS_HOST=
REDIS_PORT=
ACCESS_TOKEN_SECRET=
REFRESH_TOKEN_SECRET=
```
And then you can choose one of the following ways to start the project.
## Normal
1. Front-end
```bash
$ cd ./frontend
$ touch .env
$ npm install
$ npm run start
```
2. Back-end
```bash
$ cd ./backend
$ touch .env
$ npm install
$ npm run start
```
## Docker
```bash
$ docker-compose up
```
# Reference
MongoDB
- [MongoDB Schema Design Best Practices](https://www.mongodb.com/developer/products/mongodb/mongodb-schema-design-best-practices/)
- [Building with Patterns: A Summary](https://www.mongodb.com/blog/post/building-with-patterns-a-summary)