Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucas-erkana/chatterbox
Chatterbox: Connect and chat with others on various topics. Join public conversations or create private chat rooms. Easy to use, customizable, and personalized. Meet new people, share interests, and have fun chatting online.
https://github.com/lucas-erkana/chatterbox
mongodb nextjs typescript
Last synced: about 1 month ago
JSON representation
Chatterbox: Connect and chat with others on various topics. Join public conversations or create private chat rooms. Easy to use, customizable, and personalized. Meet new people, share interests, and have fun chatting online.
- Host: GitHub
- URL: https://github.com/lucas-erkana/chatterbox
- Owner: Lucas-Erkana
- Created: 2023-09-13T09:51:16.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-10-09T17:42:26.000Z (about 1 year ago)
- Last Synced: 2023-10-10T18:58:39.784Z (about 1 year ago)
- Topics: mongodb, nextjs, typescript
- Language: TypeScript
- Homepage:
- Size: 717 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Chatterbox 🗣️ 📱
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [ Chatterbox 🗣️](#-about-project-)
- [Live Demo](#live-demo)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [To get a local copy up and running, follow these steps.](#to-get-a-local-copy-up-and-running-follow-these-steps)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [🙏 FAQ ](#-faq-)
- [📝 License ](#-license-)
Chatterbox is a comprehensive text-based conversation app that allows users to connect with others and engage in conversations on a variety of topics. With Chatterbox, you can join public conversations or create your own private chat rooms to discuss anything you like. The app is designed to be easy to use and customizable, with a range of features that allow you to personalize your experience.
### App Screenshot
## Live Demo
To see this project's live demo, please click [here](https://chatterbox-luri.vercel.app/).
This app is built with React, Next.js, TypeScript, and MongoDB.
Client
> - Sign up
> - Sign in
> - Join public conversations
> - Create private chat rooms
## To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- A Mac or PC
- NPM (Node Package Manager) installed on your machine
- Understanding of React, Next.js, TypeScript, and MongoDB
- A web browser such as Google Chrome
- A code editor such as Visual Studio Code with Git and Node.js installed.
### Setup
To set up the Chatterbox project, follow the steps below:
1. Clone this repository to your desired folder:
```sh
git clone https://github.com/Lucas-Erkana/chatterbox.git
```
2. Navigate into the cloned folder:
```sh
cd chatterbox
```
### Install
1. Install the dependencies with NPM:
```sh
npm install
```
### Run
1. Start the development server with:
```sh
npm run dev
```
After running the `npm run dev` command, the development server will start, and you can access Chatterbox by navigating to `http://localhost:4000` in your web browser.
👤 **Lucas Erkana**
- GitHub: [@Lucask-Erkana](https://github.com/Lucask-Erkana)
- Twitter: [@Lucas_David_22](https://twitter.com/@Lucas_David_22)
- LinkedIn: [Lucas Erkana](https://www.linkedin.com/in/lucas-erkana/)
- Frontend Mentor - [@Lucask-Erkana](https://www.frontendmentor.io/profile/Lucask-Erkana)
- [ ] **Create group chat**
- [ ] **Send images in chat**
- [ ] **Offline mode**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Lucas-Erkana/chatterbox/issues).
If you like this project, please leave a ⭐️
- Thanks to JavaScript Mastery for providing a well-detailed tutorial on YouTube.
> Q1: How can I start using Chatterbox?
A1: To start using Chatterbox, you can either join public conversations or create your own private chat rooms. Simply sign up for an account, log in, and you'll be able to explore and participate in conversations right away.
> Q2: Can I customize the Chatterbox app to suit my preferences?
A2: Yes, Chatterbox is designed to be customizable. You can personalize your experience by choosing your preferred themes, notification settings, and other customization options within the app.
This project is [MIT](./LICENSE) licensed.