Telegram Chatting : Backend Realtime Chat

Create a Node.js app for building realtime chat RESTful APIs using Express.
Explore the docs »

View Web Service · Report Bug · Request Feature

Table of Contents

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Requirements
   • Installation
   • Setup .env example
3. REST API
4. Contributing
5. Related Project
6. Contributing
7. Contact
8. License

About The Project

Create a Node.js app for building realtime chat RESTful APIs using Express.

Built With

This app was built with some technologies below:

• Node.js
• Express.js
• JSON Web Tokens
• Nodemailer
• PostgreSQL
• Socket.io
• and other

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Node.js

Requirements

• Node.js
• Postman for testing
• Database

Installation

• Clone the Repo

git clone https://github.com/altrawan/realtime-chat-api.git

• Go To Folder Repo

cd realtime-chat-api

• Install Module

npm install

• Make a new database and import telegram.sql
• Setup .env
• Type npm run dev To Start Development
• Type npm run start To Start Production

(back to top)

Setup .env example

Create .env file in your root project folder.

# app
APP_NAME=
NODE_ENV=
PORT=
API_URL=
APP_CLIENT=

# database
DB_HOST=
DB_USER=
DB_PASSWORD=
DB_NAME=
DB_PORT=

# jwt
JWT_SECRET=
JWT_EXPIRED=

# google
EMAIL_FROM=
EMAIL_USER=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
REDIRECT_URI=
GMAIL_REFRESH_TOKEN=
DRIVE_REFRESH_TOKEN=

(back to top)

REST API

You can view my Postman collection here

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
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

(back to top)

Related Project

🚀 Backend Telegram Chatting

🚀 Frontend Telegram Chatting

🚀 Web Service

🚀 Demo Telegram Chatting

(back to top)

Contact

My Email : muhammadalifputra8888@gmail.com

Project Link: https://github.com/altrawan/realtime-chat-api

(back to top)

License

Distributed under the MIT License.

(back to top)