/mapgo-backend

Back-end for Intermediate studies project: Data structures and algorithms

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Mapgo

Mapgo logo

Build Status codecov TypeScript License: GPL v3

Tämä repositorio sisältää back endin lähdekoodin Aineopintojen harjoitustyö: Tietorakenteet ja algoritmit -kurssin projektille. Front endin lähdekoodi löytyy täältä. Projektin viikkoraportit tulevat löytymään back endin repositoriosta.

Mapgo-sovellukseen pääset käsiksi tästä

Projekti

Projektin ideana on toteuttaa web-sovellus, joka piirtää karttoja. Karttojen piirtämiseen käytetään reittienhakualgoritmejä, joita ovat mm. Dijkstran algoritmi, A* ja BFS.

Projektissa käytettävät tietorakenteet, algoritmit ja niihin kuuluvat testit koodataan TypeScriptillä. Front end tulee olemaan yksisivuinen Reactilla toteutettu sovellus. Front end ja back end yhdistetään käyttämällä WebSocket-yhteyttä.

Sovelluksen käyttöohjeet

  1. Kloonaa repo
  2. Suorita komento yarn
  3. Tämän jälkeen aja testit komennolla yarn test
  4. npm start

Tämän jälkeen siirry Front-endin repositorioon ja noudata siellä olevia ohjeita.

Docker

Vaihtoehtoisesti voit hakea projektin Dockerin image repositoriosta ja suorittaa sen komennolla yarn run-container. Ei aja itse testejä (vielä)

Buildaaminen Dockerilla

  1. Luo Docker-kuva komennolla yarn build-container.
  2. Käynnistä Docker-instanssi komennolla yarn run-container

Linkkejä

Front endin GitHub-repositorio

Viikkoraportit

Määrittelydokumentaatio

Testausdokumentaatio

Toteutusdokumentaatio

Typedoc

Lisenssi

Tämä projekti on lisensoitu lisenssillä GNU General Public License 3.0.