eastwood/ethermap
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Ethermap collaborative map tool inspired by etherpad.
10 Commits 2 Branches 0 Tags 520 KiB
JavaScript 95%
HTML 4%
CSS 1%
efea5051c8
Go to file
suroh efea5051c8 updated README with tech information
2023-09-14 14:43:19 +02:00
backend housekeeping renaming controllers to match CRUD and updated tests to reflect failing "/" route 2023-09-14 14:25:53 +02:00
frontend updated README with tech information 2023-09-14 14:43:19 +02:00
.env.template changed server setup to use ViteExpress to serve front and backend 2023-09-14 14:06:42 +02:00
.eslintrc.cjs changed server setup to use ViteExpress to serve front and backend 2023-09-14 14:06:42 +02:00
.gitignore changed dev and testing environments to sqlite3 2023-09-14 12:50:31 +02:00
knexfile.js changed server setup to use ViteExpress to serve front and backend 2023-09-14 14:06:42 +02:00
package-lock.json changed server setup to use ViteExpress to serve front and backend 2023-09-14 14:06:42 +02:00
package.json changed server setup to use ViteExpress to serve front and backend 2023-09-14 14:06:42 +02:00
README.md updated README with tech information 2023-09-14 14:43:19 +02:00
server.js changed server setup to use ViteExpress to serve front and backend 2023-09-14 14:06:42 +02:00
vite.config.js changed server setup to use ViteExpress to serve front and backend 2023-09-14 14:06:42 +02:00

README.md

ethermap

This is very much a janky earlydays project. All help is welcome!

An interactive map tool. A tool for collaborative planning on maps. Anyone can create new maps, and add, modify and delete locations on any map.

Install

Ethermap is built in JavaScript (soz) using NodeJS. To install you can do so by running the following commands.

To install all dependencies for the front and backend :

$ npm run install

You will then need to create a .env file in the root folder. There is a .env.template that you can copy as a guide. For a dev server you can simply copy and paste the template leaving it as is.

Then migrate the database structure :

$ npm run migrate:latest

Then you should be able to run the dev server :

$ npm run dev

You should now be able to access ethermaps on http://localhost:3000 (or whichever port you configured in your .env file).

Tech

Backend

Backend is running on express.js with ViteExpress bridging the gap between the fron and backends.

Database models, and queries are handled by objection.js ORM built on top of knex. During dev the database defaults to an Sqlite3 db, and then during production it will be able to handle whichever database you choose. For now it has only been setup to work with PostgreSQL.

Live data is shared with the client using socket.io.

Tests are written with AVA and route testing uses supertest.

Frontend

Frontend is an SPA using lit element, and some utilities by Pascal Schilp.

Map rendering is done with leaflet.

Live rendering of users is done with socket.io-client.

For the developer environment and future building, the frontend is managed by Vite.

Desires

Minimal viable functionality for this project is the following :

  • Anyone can create a map
  • Anyone can create, modify and delete points on a map that contain at least
    • name of point
    • notes on said point
  • Everyone can see current users live
    • users can choose their name
    • users can choose their cursor colour
    • user data should be remembered across visits

Things that ethermap should/could do in the future :

  • points
    • edits are all recorded
  • users
    • users can chat
    • users can also draw polygons and make labels that are not necessarily "points of interest"
  • notes
    • notes should be rich
    • note updates should also be "live"
    • notes should be attributed to users who wrote/edited them
  • osmAnd Sync!