Giter Club home page Giter Club logo

server's Introduction

Better Rail Notification Server

Better Rail's notification server provides real-time updates on ride progress, keeping passengers informed every step of the way.

Installation

To follow these steps, ensure that your environment is configured to run Node.js applications

Note: Requires NodeJS 16 or above, a redis server to store active rides and mongodb to store logs

  • Fork the repo and clone to your machine.
  • Run yarn install
  • Rename .env.example to .env, and fill it as required on Enviroment Variables
  • Run the app with yarn dev

File Structure

  • /data: stations, redis and env configurations
  • /locales: language files for notifications
  • /logs: logger and lognames sit here
  • /requests: requests to the rail api sit here
  • /rides: notification scheduler
  • /routes: express router
  • /tests: all the tests are here
  • /types: all the types are here
  • /utils: utility functions used across the server

Enviroment Variables

  • TZ: should always be "Asia/Jerusalem"
  • NODE_ENV: production or test, used to determine notifications scheduler logic
  • PORT: port express listens to
  • REDIS_URL: connection string for redis
  • MONGO_URL: connection string for mongodb
  • RAIL_URL: url of the rail api
  • APPLE_BUNDLE_ID: bundle id of the iOS app to send notifications to
  • APPLE_TEAM_ID: team id for the developer account associated with the iOS app
  • APPLE_KEY_ID: apple notifications key id
  • APPLE_KEY_CONTENT: apple notifications key content, replace new lines with \n
  • APN_ENV: apple notifications server enviroment, can be production or test
  • FIREBASE_ADMIN_AUTH: service account json for firebase project

server's People

Contributors

planecore avatar guytepper avatar

Stargazers

Micael  Illos avatar Topaz Barziv avatar

Watchers

 avatar

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.