eastwood
/
ethermap
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Ethermap collaborative map tool inspired by etherpad.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6 Commits
2 Branches
0 Tags
520 KiB
 
 
 
Tree: 357024df22
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '357024df22'
${ noResults }
ethermap/backend
suroh 357024df22
modified to have only one set of scripts for install, migration and dev env 		10 months ago
..
controllers modified to have only one set of scripts for install, migration and dev env 10 months ago
db changed dev and testing environments to sqlite3 10 months ago
middleware added frontend files and folders to git 10 months ago
routes added frontend files and folders to git 10 months ago
tests added frontend files and folders to git 10 months ago
.env.template modified to have only one set of scripts for install, migration and dev env 10 months ago
README.md added frontend files and folders to git 10 months ago
express.js added frontend files and folders to git 10 months ago
index.js added frontend files and folders to git 10 months ago
knexfile.js modified to have only one set of scripts for install, migration and dev env 10 months ago
package-lock.json modified to have only one set of scripts for install, migration and dev env 10 months ago
package.json modified to have only one set of scripts for install, migration and dev env 10 months ago
sockets.js added frontend files and folders to git 10 months ago

README.md

ethermap api

Backend for ethermap

Install

To install and run the backen you will need NodeJS and npm installed, along with access to Postgresql server (possibility for this to be any database server). Then :

$ npm i

Once all the packages are installed you should setup your .env file (follow the .env.template). Once this has all the appropriate entries you can then connect and migrate the database.

$ npm run migrate:latest

then to run the development server you should run :

$ npm run dev

Tech

The backend is made up of a REST api and websocket server. The REST api is built on Express and the websocket server is built on socket.io.

Database interface is the ODM objection.js. This setup might not be the best as it was adopted mid-project after starting with just Knex alone.

Tests are written in Ava.