Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrianarivo/chateo-nodejs
Chateo! is a web application that allows users to chat with each other in real-time. It is built with React.js, Express.js, GraphQL and MongoDB.
https://github.com/andrianarivo/chateo-nodejs
apollo-server graphql mongodb mongoose typescript
Last synced: about 17 hours ago
JSON representation
Chateo! is a web application that allows users to chat with each other in real-time. It is built with React.js, Express.js, GraphQL and MongoDB.
- Host: GitHub
- URL: https://github.com/andrianarivo/chateo-nodejs
- Owner: andrianarivo
- License: mit
- Created: 2023-10-24T05:57:56.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-01-16T16:46:53.000Z (about 1 year ago)
- Last Synced: 2024-04-18T09:35:11.977Z (10 months ago)
- Topics: apollo-server, graphql, mongodb, mongoose, typescript
- Language: TypeScript
- Homepage:
- Size: 927 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Chateo!
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
> This is the Back-end of the Chateo! project, a real-time chat
> application. See the [Front-end](https://github.com/andrianarivo/chateo-react-ui).
**Chateo!** is a web application that allows users to chat with each other in real-time. It is built with React.js,
Express.js, GraphQL and MongoDB.
Client
Server
Database
- MongoDB
- ERD:
- **Auth: Login/Logout**
- **Auth: Register**
- **Direct Messages**
- **Rooms (aka. Channels)**
- **UI/UX**
- [Live Demo Link](https://astonishing-biscuit-7921d9.netlify.app/login)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- **[Node.js](https://nodejs.org/en/)**
- **[npm](https://www.npmjs.com/)** or **[yarn](https://yarnpkg.com/)**
- Stable internet connection
- A modern web browser
- A terminal
- A code editor
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/andrianarivo/chateo-react-ui.git
```
### Install
Install this project with:
```sh
cd my-project
yarn install; cp .env.example .env
```
### Usage
To run the project, execute the following command:
- In development mode:
```sh
yarn dev
```
- In production mode:
```sh
yarn build; yarn start
```
### Run tests
**There are no tests yet, please be patient.**
To run tests, run the following command:
```sh
yarn test
```
### Deployment
You can deploy this project using your own deployment solution.
👤 **David**
- GitHub: [@andrianarivo](https://github.com/andrianarivo)
- Twitter: [@dandrianarivo](https://twitter.com/dandrianarivo)
- LinkedIn: [LinkedIn](https://linkedin.com/in/andrianarivo)
- [ ] **Forgot Password**
- [ ] **Delete rooms**
- [ ] **Improve UI/UX**
- [ ] **Markdown**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/andrianarivo/chateo-nodejs/issues/).
If you like this project consider adding a ⭐️
I would like to thank:
- Novity for the opportunity to work on this project.
- Speak icons created by Freepik - Flaticon
for the icons.
This project is [MIT](./LICENSE) licensed.