Skip to content

Commit

Permalink
Merge pull request #143 from FreeJournal/finalDocumentation
Browse files Browse the repository at this point in the history
Finish final documentation, update README for new version, remove dead code.
  • Loading branch information
pdaian committed May 4, 2015
2 parents ffbcdd3 + 27f9477 commit 177af5d
Show file tree
Hide file tree
Showing 12 changed files with 1,212 additions and 138 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,11 @@ The first step to installing FreeJournal is to ensure you have:
If you are on Windows, you can still browse one of many existing FreeJournal nodes.
Consult a list on our website.

Run python install.py in bitmessage/ and in freenet/
to install the required prerequisites, then modify config.py to
change your local node settings.

To install database, documentation, and other library requirements, run
``pip install -r requirements.txt`` on the root directory.
``sudo pip install -r requirements.txt`` on the root directory.

After this, you should perform the required Freenet and Bitmessage setup using:
``sudo ./freejournal_cli.py install all`` on a Debian-compatible distribution.

## Generating Documentation

Expand All @@ -36,20 +35,27 @@ To generate API documentation, simply run

Modify the following example commands to create and publish a collection:
```
./freejournal-cli putcollection whee 1,2,3 "This is a TEST" "nothing to see here" "nothing,to" btc123
./freejournal_cli.py putcollection whee 1,2,3 "This is a TEST" "nothing to see here" "nothing,to" btc123
Collection inserted with address/ID [BM-2cVBBDezMcgoAHMkNzMswkc3xZRMFFvKeV
./freejournal-cli publishcollection whee BM-2cVBBDezMcgoAHMkNzMswkc3xZRMFFvKeV
./freejournal_cli.py publishcollection whee BM-2cVBBDezMcgoAHMkNzMswkc3xZRMFFvKeV
```

... more coming soon
For more command usage instructions, run ``./freejournal_cli.py`` with no arguments.

## Running FreeJournal Unit Tests

Simply `python run_tests.py` in the root directory after installing the required
prerequisites.
Simply ``coverage run --omit=*/python?.?/*,*/site-packages/*,*__init__*,test_*,*Freenet* -m unittest discover unittests``
in the root directory after installing the required prerequisites to run all tests with coverage.

## Running FreeJournal - The Network

To start pulling and pushing collections to and from the network, use the following two commands:

``./freejournal_cli.py keepalive`` and ``./freejournal_cli.py listen``


## Running FreeJournal - Web interface

After configuring the web interface in config.py, use `./freejournal-cli webapp` to run an insecure
After configuring the web interface in config.py, use `./freejournal_cli.py webapp` to run an insecure
development server. Hardened deployments should use the advanced deployment guides on the Flask
website.
113 changes: 0 additions & 113 deletions controllers/api.py

This file was deleted.

File renamed without changes.
Binary file added docs/final/FreeJournal.pdf
Binary file not shown.

0 comments on commit 177af5d

Please sign in to comment.