Skip to content

Latest commit

 

History

History
112 lines (86 loc) · 3.64 KB

README.md

File metadata and controls

112 lines (86 loc) · 3.64 KB
Raw

Historio

Collaborative writing app in the style of an exquisite corpse. The objective was to enable users to write texts from scratch and to build upon previous made texts with as much freedom as possible.

Screenshot

Application is hosted here

Used technologies

  1. Neo4j as main database
  • Cypher the neo4j query language
  1. Mongodb as user database
  2. Express.js for the REST API
  3. React for the front end
  1. Password salts for increased security
  2. Azure for cloud deployment

How to run

Back-end

To run the backend, two pieces are needed:

  • Mongo database with the information on:
    • Users: username, salt and hash
  • Express REST API

The Neo4j database is running on a separate server.

Setup mongo (for Ubuntu 16.04):

  1. Install mongodb
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 9DA31620334BD75D9DCB49F368818C72E52529D4
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/4.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.0.list
sudo apt-get update
sudo apt-get install -y mongodb-org
  1. Run mongod
sudo service mogod start
  1. Populate mongo with dummy users
mongo<./back/DB/mongo/createUserTable.js

Setup Express REST API: Asuming node and npm are installed, go to folder ./back/REST/xpress/

cd ./back/REST/xpress/

Install dependencies:

npm install

Run node with --experimental-modules so that ES6 imports are allowed:

node --experimental-modules index.mjs

The back-end should now be running on port 8080.

Front-end

Asuming yarn is installed, go to folder ./front/

cd ./front/

Install dependencies:

yarn install

Run the server:

yarn start

The front-end should now be running on port 3000.

Authors

Mauricio Neira - 201424001

David Narvaez - 201516897

MIT License

MIT License

Copyright (c) 2018 Mauricio Neira

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

See file ./LICENCE for complete information.