Code Monkey home page Code Monkey logo

covid19-updates's Introduction

covid19-updates (India)

Simple web app to send daily covid-19 cases updates to users using Node, Express.js, Twilio Api and some other packages.

GitHub license

About

This application uses Twilio API to send daily covid-19 cases updates to the registered users.
Data Source - Covid 19 India API (Unofficial)
This web app is a part of Dev-Twilio Hackathon on dev.to

How it works

Users register with their Name, Phone Number and State (currently only Gujarat and Maharashtra is available) and they will get daily updates of cases in their state and in India, twice a day(9 am & 8 pm) via SMS (Twilio SMS Api)
User can choose to stop the service by sending "STOP" to the number(Twilio Number).

Features

  • Node.js web server using Express.js
  • Basic web user interface using EJS for templating and Bootstrap for UI
  • User interface to register
  • Project Specific environment variables using .env files.

Usage

Requirements

Twilio Account Settings

Config Value Description
Account Sid Your primary Twilio account identifier - find this in the Console.
Auth Token Used to authenticate - just like the above, you'll find this here.
Phone number A Twilio phone number in E.164 format - you can get one here

Local development

After the above requirements have been met:

  1. Clone this repository and cd into it
git clone https://github.com/jamesshah/covid19-updates.git
cd covid19-updates
  1. Install dependencies
npm install
  1. Set your environment variables in .enc
create .env file in /covid19-updates directory

See Twilio Account Settings to locate the necessary environment variables.

  1. Run the application
npm start

This will run the server using nodemon package. It will reload whenever you change any files.

  1. Navigate to http://localhost:3000

That's it!

Contributing

ToDo

  • Build a basic working app
  • Update Readme File
  • Add more states and regions

This template is open source and welcomes contributions.

Visit the project on GitHub

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.

covid19-updates's People

Contributors

jamesshah avatar dependabot[bot] avatar

Stargazers

Pascal Kania avatar

Watchers

James Cloos avatar  avatar

Forkers

ahmedgmurtaza

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.