Skip to content

FLawrence/kolo-django

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kolo Workshop Material

Repository for King's Collaborator Locator (KoLo)

DISCLAIMER

Disclaimer: this is an incomplete prototype put together only for running a workshop. It is not a recommended solution, just a support material for explaining the way you could build your front-end app.

One-off initial set up

[OPTIONAL] Install the Database Manager (CouchDB)

  • download kitematic from the web
  • install it on your machine
  • run kitematic
  • search for couchdb
  • look at the first item in the result (labelled 'official')
  • click the ... at the bottom right of the little box
  • click the blue 'latest'
  • click 1.6.1
  • click the little blue cross in the bottom right corner of th little box
  • click 'Create'

Install the prototype

  • create a folder 'kolo'
  • cd into 'kolo'
  • git clone [email protected]:kingsdigitallab/kolo-django.git
  • copy the 'confidential' folder into 'kolo'

Data Import

Prepare and upload the data

  • Visit the kolo-person sheet on Google
  • Export it as CSV
  • Rename it people.csv
  • Move it into your confidential folder
  • Browse the import.html webpage
  • Press the import button

(Re)starting the environment

[OPTIONAL] CouchDB

  • start Kitematic
  • click chouchdb in the left panel
  • check if the chouchdb container is started (green circle)
  • if the circle is grey, click 'star' button in the horizontal toolbar near the top
  • for first time: ** take note of the 'Access URL' in the right panel (localhost:XXXX) ** set confidential/settings.js to 'http://localhost:XXXX/kolo' (see above for the value of XXX) ** go to http://localhost:32768/_utils/config.html ** set credentials = true ** add cores, origins, * ** set enable_cors = true

Local web server

Libraries

Libraries used in this prototype:

  • Vue.js: a client-side html templating system. Generates UI from json data.
  • PouchDB: a javascript library to manipulate CouchDB data
  • jQuery: a javascript library to simplify HTML manipulation
  • Bulma: a minimal CSS framework that works well with Vue.js

About

Repository for King's Collaborator Locator (KoLo)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 83.5%
  • JavaScript 14.0%
  • Python 1.6%
  • CSS 0.9%