Skip to content
This repository has been archived by the owner on Feb 19, 2022. It is now read-only.
Mia edited this page Aug 4, 2013 · 39 revisions

Software documentation

A note from the dev and design team: we're still madly working on code for launch, so there's not necessarily a lot here for launch but we'll be adding more docs while we're in code freeze...

Software libraries used

Note during the build: some were listed at https://github.com/chnm/petulant-adventure/issues/9 which could now be closed. The developers have to add libraries to the requirements.txt file so that's probably the best place to pull the list from.

Documentation for developers/forkers of the tool

Relevant Python standards are...

Note for everyone: if you change the number of results per page (or move to dynamic page load by device) then adjust the query logic re the mix of results per aggregator.

Check and pull in notes from https://github.com/chnm/petulant-adventure/blob/master/README.md

Top tip: be consistent in your use of localhost vs 127.0.0.1.

Deployment notes - GitHub to AWS

To dev (heroku)

For now see notes on https://github.com/chnm/serendipomatic/issues/96 and https://github.com/chnm/serendipomatic/issues/106

To live (AWS)

(Mia's version of Rebecca's notes - to be fixed) SSH into the AWS instance. Git pull. Check env settings: /$path/%to/$envgoeshere Check for new requests Sync db in case of database changes Run collect static (for CSS, images, etc) Touch apache wsgi.py

Documentation for repositories

If you want to be included, the first step is: have a good API with a clear statement re content licence for re-use. Then you can either fork the code, update it to include your API and push it back, or fund project developers to do that for you. If you update the code yourself, be careful around the 'magic box' dynamic query generation code (assuming we get that finished).

Please check that the code will recognise when results have been pulled from your repository and link to the appropriate catalogue search page from the results page.

Individual results always link to the providing source, not the repository.

Documentation for end users

Clone this wiki locally