Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrey-lawyer/react-socket-chat
https://github.com/andrey-lawyer/react-socket-chat
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/andrey-lawyer/react-socket-chat
- Owner: andrey-lawyer
- Created: 2024-02-08T15:37:51.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-11T15:04:54.000Z (11 months ago)
- Last Synced: 2024-02-12T10:25:52.326Z (11 months ago)
- Language: TypeScript
- Homepage: https://reacy-sockets.onrender.com
- Size: 141 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website with React and Socket
- [Introduction](#introduction)
- [Installation](#installation)
- [Build](#build)
- [Deployment](#deployment)
## Introduction
This frontend project is built using the following technologies:
- React: A JavaScript library for building user interfaces.
- Vite: A next-generation frontend tooling system.
- Socket.IO: A JavaScript library for real-time web applications, enabling real-time, bidirectional communication between clients and servers.
## Installation
1. **Clone the repo**
```bash
github.com/andrey-lawyer/react-socket-chat
```
2. **Navigate to the project directory:**
```bash
cd react-socket-chat
```
3. **Install dependencies** It's recommended to use npm:
```
npm install
```
4. **Create a .env file** in the root directory with the following content:
- REACT_APP_BACKEND_URL=url for backend
- REACT_APP_CAPTCHA_KEY=your key google recaptcha
5. **Start the development server:**
```bash
npm run dev
```
## Build
```bash
# production
$ npm run build
```
## Deployment
The project is currently deployed on [Render](https://reacy-sockets.onrender.com).
Feel free to check the live deployment and interact with the application.
**Docker**
This project supports Docker, making it easy to deploy. To deploy the project, follow these steps:
1. **Install Docker:** If you don't have Docker installed on your computer yet, you can download and install it from the official Docker website.
2. **Get Docker images:** You can get Docker images for this project from Docker Hub:
- For the backend: docker pull andreylawyer/nest-socket
- For the frontend: docker pull andreylawyer/andreyprojects-frontend
3. **Run containers:** Once the images have been successfully obtained, you can run the containers using the following commands:
- For the backend: docker run -d -p 3000:3000 andreylawyer/nest-socket
- For the frontend: docker run -d -p 80:80 andreylawyer/andreyprojects-frontend
4. **Check the project:** After running the containers, you can check the project's functionality by opening its web interface in your browser at the following address:
- For the backend: [docker run -d -p 3000:3000 andreylawyer/nest-socket](http://localhost)
- For the frontend: [docker run -d -p 80:80 andreylawyer/andreyprojects-frontend](http://localhost:3000)