NiketanG / shipper-web

Frontend for Traffic Management for Coastal Regions. Developed for ASEAN-India Hackathon 2021

Shipper

Web

Traffic Management System for Coastal Regions. Developed for ASEAN-India Hackathon 2021 - PS7 and won Encouragement Award.

Demo

Shipper-Web

For Backend - Refer to Shipper-Server

Local Development

Prerequisites

• Mapbox Account & Access token
• Shipper-Server running
• Node.js Installed

Environment Variables

To run this project, you will need to add the following environment variables to your .env file An (env.example)[.env.example] file is provided in the repo.

REACT_APP_MAPBOX_ACCESS_TOKEN Access token from Mapbox

REACT_APP_API_URL Url of Shipper-Server

Install Dependencies

yarn install
or
npm install

Start Development Server

yarn dev
or
npm run dev

This will start a develoment server for the frontend on http://localhost:3000

---

Deployment

Create a production build

This will create a production build that can be deployed.

yarn build
or
npm run build

For Deploying, you can use Docker (with Docker Compose).

docker-compose up --build

---

Getting Started

Open the application in your web browser on http://localhost:3000

Enter your email address and name on the login page, you will be redirected to the dashboard.

The map uses an initial location (not your current location) for demo purposes. Use the Controls in Bottom Left corner for navigation. Based on the ships around you, warnings and alerts will be displayed.

The locations of all ships (including yours) are synchronized in real time, so as you move, all other ships around you will also see your movements.

---

LICENSE

Eclipse Public License (EPL)

You are free to modify the code. Redistributions are not allowed without prior request from the original author. You are obligated to include the full license and the copyrights.