Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adisreyaj/staysafe-backend
Stay Safe Backed
https://github.com/adisreyaj/staysafe-backend
Last synced: 22 days ago
JSON representation
Stay Safe Backed
- Host: GitHub
- URL: https://github.com/adisreyaj/staysafe-backend
- Owner: adisreyaj
- License: apache-2.0
- Created: 2020-04-10T17:41:52.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:02:00.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T10:44:02.187Z (2 months ago)
- Language: TypeScript
- Size: 2.78 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Welcome to Stay Safe 👋
> Stay Safe is an application to track and learn about Pandemic disease and how to fight them.
## 🔥 Features
- Modularized design
- MongoDB as the Database
- Communication Queue for processing SMS, Notifications, and Emails
- Encryption of firebase configuration for easy deployment
- Caching of Data for better performance
- Cron Job for automatic updates of data and sending out notifications
## 🚀 Usage
Make sure you have the pre-requisites installed on your system. You can start by cloning/downloading the repo to your local system.
1. Install the dependencies of the applications
```
npm install
```
2. Copy the `.env.example` to another file and name it as `.env`
```
cp .env.example .env
```
3. Start the application using the command
```
npm run start:dev
```
## 🔥 Services Used
1. **Firebase** - for push notifications
1. **Twilio** - for SMS messages
1. **SendGrid** - for Emails notifications
1. **NewsAPI** - for getting related news
1. **RapidAPI** - for statistic data
## 🛠 Environment Variables
```
#Application Configuration
PORT=
CACHE_EXPIRY_SECONDS=
ENCRYPT_KEY=
#API Configurations
X_RAPIDAPI_HOST=
X_RAPIDAPI_KEY=
WORLD_STATS_URL=
WORLD_TOTAL_NUMBERS=
INDIA_STATS_URL=
#News API Configuration
NEWSAPI_KEY=
NEWSAPI_URL=
#DB Configurations
MONGODB_URI=
REDIS_HOST=
REDIS_PORT=
REDIS_PASSWORD=
#Twilio Configurations
TWILIO_ACCOUNT_SID=
TWILIO_AUTH_TOKEN=
TWILIO_PHONE_NUMBER=
TWILIO_VERIFICATION_APP_SID=
SENDGRID_API_KEY=
FROM_EMAIL=
# Firebase DB URL
FIREBASE_DB_URI=
```
## 🤝 Contributing
Contributions, issues and feature requests are welcome.
Feel free to check [issues page](https://github.com/adisreyaj/staysafe-backend/issues) if you want to contribute.
## Author
👤 **Adithya Sreyaj**
- Twitter: [@AdiSreyaj](https://twitter.com/AdiSreyaj)
- Github: [@adisreyaj](https://github.com/adisreyaj)
## 👍🏼 Show your support
Please ⭐️ this repository if this project helped you!
## 📝 License
Copyright © 2020 [Adithya Sreyaj](https://github.com/adisreyaj).
This project is [Apache License 2.0](https://github.com/adisreyaj/staysafe-backend/blob/master/LICENSE.md) licensed.