Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextpointer/goop
A real time chat platform with room feature
https://github.com/nextpointer/goop
bun socketio typescript
Last synced: about 1 month ago
JSON representation
A real time chat platform with room feature
- Host: GitHub
- URL: https://github.com/nextpointer/goop
- Owner: nextpointer
- License: mit
- Created: 2024-10-08T17:58:42.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-19T15:01:31.000Z (3 months ago)
- Last Synced: 2024-10-25T12:52:36.896Z (2 months ago)
- Topics: bun, socketio, typescript
- Language: TypeScript
- Homepage:
- Size: 89.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Goop
Goop is a real-time chat application with a frontend built using React and a backend using Express, Socket.IO, and Bun runtime. This documentation provides instructions for setting up both the frontend and backend of the project.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Project Structure](#project-structure)
- [Installation](#installation)
- [Clone the Repository](#clone-the-repository)
- [Frontend Setup](#frontend-setup)
- [Backend Setup](#backend-setup)
- [Accessing the Application](#accessing-the-application)
- [Common Issues](#common-issues)
- [Contributing](#contributing)
- [License](#license)
## Prerequisites
Make sure you have the following installed:
- **Bun**: A JavaScript runtime. [Installation Guide](https://bun.sh/docs/installation)
- **Git**: For cloning the repository.
## Project Structure
The Goop project has two main parts:
- **Frontend**: React-based user interface
- **Backend**: Express and Socket.IO server for real-time communication
The project structure looks like this:
```
/goop
├── /frontend # React-based frontend code
└── /backend # Express and Socket.IO backend code
```
## Installation
### Clone the Repository
1. Open your terminal and clone the Goop repository:
```bash
https://github.com/nextpointer/goop.git
```
2. Navigate into the project directory:
```bash
cd goop
```
### Frontend Setup
1. Navigate to the frontend directory:
```bash
cd frontend
```
2. Install the dependencies using Bun:
```bash
bun install
```
3. Start the development server:
```bash
bun run dev
```
The frontend should now be running at `http://localhost:5173`.
### Backend Setup
1. Navigate to the backend directory:
```bash
cd ../backend
```
2. Install the dependencies using Bun:
```bash
bun install
```
3. Start the backend server with hot-reloading:
```bash
bun run --hot src/index.ts
```
This command runs the backend server with automatic hot-reloading enabled. The server should start on `http://localhost:3000`.
## Accessing the Application
Visit the following URL in your web browser to access the Goop application:
```
http://localhost:5173
```
You can now use Goop to join chat rooms, send messages, and interact in real-time.
## Common Issues
- **Port Conflicts**: If you encounter port conflicts, change the port number in your backend or frontend configuration.
- **CORS Errors**: Ensure that your backend CORS settings allow requests from the frontend's origin.
## Contributing
We welcome contributions to improve Goop! To contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Open a Pull Request.
## License
This project is licensed under the MIT License.
```
This version of the `README.md` file includes the steps for cloning the repository using Git, which will help users get started with setting up the project on their local machine. Let me know if you need any further adjustments!