https://github.com/aryan75way/chat-app-backend
An express.js and socket.io backend application, with chat features.
https://github.com/aryan75way/chat-app-backend
expressjs socket-io
Last synced: 5 months ago
JSON representation
An express.js and socket.io backend application, with chat features.
- Host: GitHub
- URL: https://github.com/aryan75way/chat-app-backend
- Owner: Aryan75Way
- Created: 2025-02-11T08:27:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-19T14:13:20.000Z (over 1 year ago)
- Last Synced: 2025-07-10T20:46:53.598Z (12 months ago)
- Topics: expressjs, socket-io
- Language: TypeScript
- Homepage:
- Size: 175 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Running Locally
> [!NOTE]
> This project uses [pnpm](https://pnpm.io/) only as a package manager.
1. Clone the repository:
```bash
git clone https://github.com/iAryanK/chat-app-backend.git
```
2. Navigate to the project directory:
```bash
cd ./chat-app-backend
```
3. Create a .env.development file & Copy the below environment variables to `.env.development`.
```bash
PORT = 3000
NODE_ENV = "development"
JWT_SECRET="TopSecret"
```
4. Install dependencies:
```bash
pnpm install
```
5. Start the development server:
```bash
pnpm dev
```
6. Access the application in your browser:
```bash
http://localhost:3000
```
## API Documentation
- Swagger API Documentation is available at `/api-docs` route.
```bash
http://localhost:3000/api-docs
```
## ER Diagram
