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.
$ sudo su
$ npm install -g gulp
$ npm install -g bower
$ exit
$ mkdir bh
$ cd bh
$ git clone http://....
$ cd dbs-front
$ npm install
$ bower install
$ gulp serve
Then head to http://localhost:3000 in your browser.
$ gulp test
$ gulp build-all
To send request to different server than the default local server
http://localhost:5000, set the API_SERVER environment variable to one of
live, test, local:
$ API_SERVER=live gulp serve
We are using BrowserStack for automated testing. After deployment, we take screenshots from different urls - you can review them on Browserstack.
To build a distribution for live deployment, run:
$ API_SERVER=live gulp dist
Don't forget to set API_SERVER to the desired one.
If you like to test the built version using the local development server, after
gulp dist run:
$ gulp serve:dist
Contributions from both Jews and non-Jews 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:
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
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