Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 1.98 KB

README.md

File metadata and controls

70 lines (48 loc) · 1.98 KB

CI status

Beit-Hatfusot Front-End README

Welcome to the frontend of the museum of the jewish people. The code is in Javascript using Angular 1.4.x and licensed under AGPLv3. Please feel free to fork and send us pull requests.

Our distant backend is the system known as BHP, an ancient Windows based client-server software still used by our team of editors, volunteers and museum visitors. Our direct backend is an API server written in Python using Flask, accessing data in a Mongo & ElasticSearch cluster. The cluster is filled with data from BHP using our migration bot.

Blog Ptosts

Dependencies

$ sudo su
$ apt-get install ruby
$ gem install sass
$ npm install -g grunt-cli
$ npm install -g bower
$ exit

Getting the code and dependecies

$ mkdir bh
$ cd bh
$ git clone http://....
$ npm install
$ bower install

Test & Build

$ grunt karma
$ grunt build

Contributing

Contributions from both Jews and Gentiles are welcomed! We even have a beginner label to help you start with (hopefully) simple issues. Once you have an issue, just follow these simple steps:

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Documentation

Change Log

We have very partial documentation so far. What we have, had been generated by generator-ngdoc After generation, the (generated) src folder have been removed, since it was not needed.

In order to serve the docs http://localhost:3000 run:

$ cd docs
$ bower install
$ gulp docs:serve