gada121982 / gada-sms-project

Gada SMS is a project that i maked during working at Gcalls company

Gada SMS

Provide you a service to send sms and manage sms
View video introduce · View product · Report Bug · Request Feature

⚠️ If you want to run this app: You might have an api to send sms, so this document is for reference purposes only, you can see demo bellow!

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• API
• Contributing
• Contact

About The Project

Gada SMS is a service that provide to client on Salesforce can send sms to their customer. We will get contact list fom client's Salesforce account. Beside that, we support an application to client for manage the messages was sent.

Built With

• ReactJS
• Redux
• NodeJS
• JWT
• ExpressJS
• JSforce
• MongooseJS
• Docker

Getting Started

Follow instructions bellow to setting up your project locally.

Prerequisites

1. Install Nodejs: Install NodeJS Document
2. Install Docker: Install Docker Document
3. Sign up Salesforce account: Sign up Salesforce Account
4. Setup connected apps on Salesforce for OAuth: Setting OAuth Salesforce Application

Now, you can copy Client ID, Client Secret to set up dotenv file later

5. Create an api to send sms: ‼️ Now, you have to buy an api from 3rd party provider to send sms purpose. I suggest: Vietguys

Installation

1. Clone the repository

git clone https://github.com/gada121982/Gada-sms-project

2. Move to server foler

cd Gada-sms-project/server/

3. Setting up .env file

4. Build Dockerfile

docker build -t gcalls-app .

docker run -p 8000:8000 -d gcalls-app

API

Authencation api

• GET /auth/loginsf
• POST /auth/loginsf
• GET /auth/loginsf/callback
• GET /auth/login
• POST /auth/login
• POST /auth/logout
• POST /auth/admin/logout

Admin api

Those api have admin middleware for authentication admin account

• GET /admin

• GET /admin/history

• GET /admin/usersf/all

• POST /admin/user/add

• POST /admin/user/delete

• POST /admin/user/edit

• GET /admin/user/all

• POST /admin/template/add

• POST /admin/template/update

• POST /admin/template/delete

• GET /admin/template/all

• POST /admin/category/add

• POST /admin/template/delete

• POST /admin/template/getall

Message api

Those api have manage middleware for authentication user account

• GET /api/message/contactlist
• GET /api/message/category/getall
• GET /api/message/template/all
• GET /api/template/all
• GET /api/template/getbycategory

Proxy api

Those api have manage middleware for authentication user account

• POST /api/proxy/send

Render message page

Those api have manage middleware for authentication user account

• GET /message

Render manage page

Those api have manage middleware for authentication user account

• GET /
• GET /api/allcontact

Contributing

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

Contact

Nguyen Vinh Hai
github.com/gada121982

@NguynVnhHi1 - Linkedin - [email protected]