diff --git a/README.md b/README.md index 3280c85..660f609 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,17 @@ This program provides a searchable interface to your ASL magazines and their articles. - - - +[](doc/publishers.png)   - - - +[](doc/publication.png)   - - - +[](doc/search.png)   - - - +[](doc/tag.png) -*NOTE: This project integrates with my other [asl-rulebook2](https://github.com/pacman-ghost/asl-rulebook2) project. Add a setting to your `site.cfg` e.g.* - -``` ASLRB_BASE_URL = http://localhost:5020 ``` +*NOTE: This project integrates with my other [asl-rulebook2](https://code.pacman-ghost.com/public/asl-rulebook2) project. Add a setting to your `site.cfg` e.g.* +``` +ASLRB_BASE_URL = http://localhost:5020 +``` *and references to rules will be converted to clickable links that will open the ASLRB at that rule.* @@ -27,9 +20,8 @@ This program provides a searchable interface to your ASL magazines and their art Get a copy of the pre-loaded database from the release page. Then go to the project root directory and run the following command: - ``` - ./run-containers.sh -d /home/pacman-ghost/asl-articles.db +./run-containers.sh -d /home/pacman-ghost/asl-articles.db ``` *NOTE: You will need Docker >= 17.05 (for multi-stage builds)*, and `docker-compose`. @@ -45,17 +37,15 @@ It is possible to configure publications and their articles so that clicking the For security reasons, browsers don't allow *file://* links to PDF's, they must be served by a web server. This program supports this, but some things need to be set up first. When you run the application, specify the top-level directory that contains your PDF's in the command line e.g. - ``` - ./run-containers.sh \ - -d /home/pacman-ghost/asl-articles.db \ - -e /home/pacman-ghost/asl-articles-docs/ +./run-containers.sh \ + -d /home/pacman-ghost/asl-articles.db \ + -e /home/pacman-ghost/asl-articles-docs/ ``` Then, configure your document paths *relative to that directory*. For example, say I have my files organized like this: - ``` * /home/pacman-ghost/ +-- asl-articles.db @@ -77,14 +67,16 @@ The application is split over 2 Docker containers, one running a React front-end ##### Setting up the Flask (Python) back-end Create a *virtualenv*, then go to the *asl_articles/* directory and install the requirements: - -```pip install -e .[dev]``` +``` +pip install -e .[dev] +``` Copy *config/site.cfg.example* to *config/site.cfg*, and update it to point to your database. Then run the server: - -```./run-server.py``` +``` +./run-server.py +``` You can test if things are working by opening a browser and going to http://localhost:5000/ping @@ -93,9 +85,11 @@ You can test if things are working by opening a browser and going to http://loca ##### Setting up the React front-end Go to the *web/* directory and install the requirements: - -```npm install``` +``` +npm install +``` Then run the server: - -```npm start``` +``` +npm start +``` diff --git a/setup.py b/setup.py index 58aa4fc..fef527d 100644 --- a/setup.py +++ b/setup.py @@ -31,6 +31,7 @@ setup( version = "1.1", # nb: also update constants.py description = "Searchable index of ASL articles.", license = "AGPLv3", + url = "https://code.pacman-ghost.com/public/asl-articles", packages = find_packages(), install_requires = parse_requirements( "requirements.txt" ), extras_require = {