jankupczyk/marine-traffic

Marine Traffic Frontend 🛳

🛳

Marine Traffic - Frontend

MarineTraffic is an app, which provides real-time information on the movements of ships around Norway

Frontend - Backend

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Todo
• Contributing
• License
• Contact
• Acknowledgements

Marine Traffic - Presentation (Video)

About The Project

MarineTraffic is an app, which provides real-time information on the movements of ships around Norway. MarineTraffic is a contribution for the programming competition, organized by CTM and held by Przemysław Bykowski

This repo contains frontend part of project, you can find backend part here

Some screenshots to help you visualize final product

You can switch between different layers

You can change languages (English, Polish, Norwegian)

In the left bottom corner you'll find cursor-indicator

You can toggle markers on/off

User position detection

Built With

Svelte Typescript

Getting Started

To get a local copy up and running follow these simple steps.

Installation

This is a project template for Svelte apps. It lives at https://github.com/sveltejs/template.

To create a new project based on this template using degit:

npx degit sveltejs/template svelte-app
cd svelte-app

Note that you will need to have Node.js installed.

Install the dependencies...

cd svelte-app
npm install

...then start Rollup:

npm run dev

Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

If you're using Visual Studio Code we recommend installing the official extension Svelte for VS Code. If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.

Usage

You can view API documentation here

For more examples, please refer to the Swagger Documentation or use OpenAPI docs

Roadmap

See the open issues for a list of proposed features (and known issues).

Todo

• add more languages support
• auto refresh vessels position
• add more screens
• consume more APIs

Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

The code in this repository is covered by the included license.

However, if you run this code, it may call on the BarentsWatchAPI, which are covered by BarentsWatchAPI's Developer licenses. You can learn more about BarentsWatch licensing at this link

Contact

Through Github: https://github.com/jkbkupczyk

Project Link: https://github.com/jkbkupczyk/marine-traffic