Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/farooqpk/talker-backend
https://github.com/farooqpk/talker-backend
audiocall cloudflare-r2 docker-compose express-js gemini-ai mongodb nginx prisma realtimechat redis socket-io typescript videocall
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/farooqpk/talker-backend
- Owner: farooqpk
- Created: 2023-05-20T16:44:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-29T17:19:45.000Z (21 days ago)
- Last Synced: 2024-10-29T18:45:14.826Z (21 days ago)
- Topics: audiocall, cloudflare-r2, docker-compose, express-js, gemini-ai, mongodb, nginx, prisma, realtimechat, redis, socket-io, typescript, videocall
- Language: TypeScript
- Homepage:
- Size: 605 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Talker Backend
This is the backend server for a real-time chat application built with Node.js and Socket.IO.
## Prerequisites
- Node.js
- npm
- MongoDB## Installation
1. Clone the repository:
git clone https://github.com/farooqpk/talker-backEnd.git
2. Navigate to the project directory:
cd talker-backEnd
3. Install dependencies:
npm install
4. Create a `.env` file in the root directory and add the following environment variables:
PORT=your_port_numberDATABASE_URL=your_mongodb_url
ACCESS_TOKEN_SECRET=your_access_token_secret
REFRESH_TOKEN_SECRET=your_refresh_token_secret
REDIS_URL=your_redis_url
R2_ACCOUNT_ID=your_cloudflare_r2_account_id
R2_ACCESS_KEY=your_cloudflare_r2_access_key
R2_SECRET_KEY=your_cloudflare_r2_secret_key
R2_BUCKET_NAME=your_cloudflare_r2_bucket_name
NODE_ENV='development'
GEMINI_API_KEY=your_gemini_api_key
CERTBOT_EMAIL=your_certbot_email
ACCESS_TOKEN_EXPIRY=2
REFRESH_TOKEN_EXPIRY=30
## Building for Production
To create a production build:
npm run build
The built files will be in the `dist` directory.
## Usage
1. Start the server:
npm start
2. The server will be running on `http://localhost:8000` (or the port you specified in the `.env` file).
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a pull request## Contact
- LinkedIn: [Ummar Farooq PK](https://linkedin.com/in/ummarfarooq-pk)
- Live Demo: [talker.fun](https://talker.fun)