Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-template-hub/sms-server-template
SMS Server Template is a generic open-source sms server that has a simple yet powerful design to connect your business with third-party sms service providers (like Twilio, Amazon SNS).
https://github.com/open-template-hub/sms-server-template
sms sms-api sms-client sms-gateway sms-messages sms-notifications sms-sdk
Last synced: 27 days ago
JSON representation
SMS Server Template is a generic open-source sms server that has a simple yet powerful design to connect your business with third-party sms service providers (like Twilio, Amazon SNS).
- Host: GitHub
- URL: https://github.com/open-template-hub/sms-server-template
- Owner: open-template-hub
- License: mit
- Created: 2021-12-18T12:30:57.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-27T07:08:59.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T01:38:51.992Z (8 months ago)
- Topics: sms, sms-api, sms-client, sms-gateway, sms-messages, sms-notifications, sms-sdk
- Language: TypeScript
- Homepage: https://opentemplatehub.com/en-US/product/server/sms-server-template
- Size: 92.8 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Open Template Hub - SMS Server Template v5
[](LICENSE)
[](https://github.com/open-template-hub/sms-server-template/issues)
[](https://github.com/open-template-hub/sms-server-template/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/open-template-hub/sms-server-template/commits/master)
[](https://github.com/open-template-hub/sms-server-template/releases)
[](https://sonarcloud.io/dashboard?id=open-template-hub_sms-server-template)
SMS Server Template is a generic open-source sms server that has a simple yet powerful design to connect your business with third-party sms service providers (like Twilio, Amazon SNS).
## Ways to Begin
### 1. Express Deploy
Deploy this template to Heroku
[](https://heroku.com/deploy?template=https://github.com/open-template-hub/sms-server-template)
### 2. Start with Server Generator
Create your server with Server Generator Package
[](https://www.npmjs.com/package/@open-template-hub/server-generator)
### 3. GitHub Template
Use this repository as a Template
[](https://github.com/open-template-hub/sms-server-template/generate)
## Installations
Install **nodejs** and **npm** via **[nodejs.org](https://nodejs.org)**.
Check installed versions of **nodejs** and **npm** via running following commands:
```
node -v
npm -v
```
Check project's current **nodejs** and **npm** version from **[package.json](package.json)**.
## Environment Variables
If you don't give **RESPONSE_ENCRYPTION_SECRET**, response encryption mechanism will be disabled automatically.
``` applescript
PORT=4007
PROJECT=OTH
MODULE=SmsServer
ENVIRONMENT=Local
MONGODB_URI={Database Connection Url}
MONGODB_CONNECTION_LIMIT={MongoDB Connection Limit}
CLOUDAMQP_APIKEY={MQ Api Key}
CLOUDAMQP_URL={MQ Connection Url}
SMS_SERVER_QUEUE_CHANNEL=oth_sms_queue
ORCHESTRATION_SERVER_QUEUE_CHANNEL=oth_orchestration_queue
REDISCLOUD_URL={Redis Connection Url}
REDIS_CONNECTION_LIMIT={Redis Connection Limit}
ACCESS_TOKEN_SECRET={Access Token Secret}
RESPONSE_ENCRYPTION_SECRET={Response Encryption Secret}
DEFAULT_LANGUAGE={Language Code}
```
### Example Preconfigured Message:
```json
{
"key": "2FACodeSend",
"messages": [
{
"language": "en",
"message": "Hello ${username}, here is your 2FA code ${twoFactorCode}"
}
],
"payload": {
"twilio": {
"from": "{Your Twillio Phone Number}"
}
}
}
```
### Service Provider Configurations
#### 1. Twillio
```json
{
"key": "TWILIO",
"description": "Twilio SMS Provider",
"payload": {
"accountId": "{Your Twillio Account Id}",
"authToken": "{Your Twillio Account Token}",
"serviceId": "{Your Twillio Service Id}",
"from": "{Your Twillio Phone Number}"
}
}
```
## Http Requests
You can find list of available http request in the [requests](assets/requests) directory. You can run http requests directly via **WebStorm**, for more information check out: [jetbrains.com/help/idea/http-client-in-product-code-editor.html](https://jetbrains.com/help/idea/http-client-in-product-code-editor.html)
## Contributors
Furkan Yavuz
💬 📖 👀
Fatih Turker
💬 📖 👀
Mert Sarac
💬 📖 👀
## Contributing
Refer to **[CONTRIBUTING.md](https://github.com/open-template-hub/.github/blob/master/docs/CONTRIBUTING.md)** to see how to contribute to Open Template Hub.
## Code of Conduct
Refer to **[CODE_OF_CONDUCT.md](https://github.com/open-template-hub/.github/blob/master/docs/CODE_OF_CONDUCT.md)** to see contributor covenant code of conduct.
## LICENSE
The source code for this project is released under the [MIT License](LICENSE).