Commit 4b7f84fd authored by Remi Rampin's avatar Remi Rampin

Update README, CHANGELOG, and tests

parent 14a6142c
Pipeline #52825666 passed with stage
in 2 minutes and 4 seconds
......@@ -18,6 +18,7 @@ Features:
* "New highlight" button shows up next to selected text rather than mouse, making it work with touch screens (mobile) and screen readers (hopefully)
* Convert old .DOC files (Word 97) using WV if available
* Add collaborator management modal, to add more members to a project
* Changed default port number from `8000` to `7465`
0.4.4 (2018-11-29)
------------------
......
......@@ -26,7 +26,7 @@ Installers
Grab the correct installer for your system from `our release page <https://gitlab.com/remram44/taguette/tags>`__. Those include Python, Taguette, and Calibre, so you don't need to install anything else. A "Taguette" entry should appear in your list of applications (Start Menu on Windows, or Launchpad/Spotlight on MacOS).
Once you start the application, you will see a terminal appear. This is normal! You can ignore the strange messages there, and use Taguette from your web browser (`localhost:8000 <http://localhost:8000/>`__ should open automatically). Simply leave the terminal window open until you are done using Taguette, after which you can close that terminal window to stop Taguette.
Once you start the application, you will see a terminal appear. This is normal! You can ignore the strange messages there, and use Taguette from your web browser (`localhost:7465 <http://localhost:7465/>`__ should open automatically). Simply leave the terminal window open until you are done using Taguette, after which you can close that terminal window to stop Taguette.
Installation using pip
----------------------
......@@ -37,14 +37,14 @@ Once you've installed Python, you can install Taguette with its dependencies fro
pip install taguette
After which you can simply run ``taguette`` in the terminal to get it going. You'll see the command line will still be running. This is ok! Don't worry about the terminal, but do leave it running. A browser window should appear, pointing you to `localhost:8000 <http://localhost:8000/>`__, and you can begin working on your projects!
After which you can simply run ``taguette`` in the terminal to get it going. You'll see the command line will still be running. This is ok! Don't worry about the terminal, but do leave it running. A browser window should appear, pointing you to `localhost:7465 <http://localhost:7465/>`__, and you can begin working on your projects!
Run with Docker
---------------
You can run this with Docker, note that it will prompt you for an 'admin' password the first time::
docker run -ti -p 8000:8000 -v /srv/taguette:/data remram/taguette
docker run -ti -p 7465:7465 -v /srv/taguette:/data remram/taguette
Installation from a local clone
-------------------------------
......@@ -56,12 +56,12 @@ You can also install from a local clone of this repository, which will allow you
3. Taguette uses `Poetry <https://poetry.eustace.io/>`__ for its packaging and dependency management. You will need to `install Poetry <https://poetry.eustace.io/docs/#installation>`__
4. Install Taguette and its dependencies by running ``poetry install``. We recommend you run this inside of a `virtualenv or pipenv <https://docs.python-guide.org/dev/virtualenvs/>`__ if possible.
5. You can start taguette in development mode using ``taguette --debug`` (or ``taguette --debug server <config_file>``). This will start Tornado in debug mode, which means in particular that it will auto-restart every time you make changes.
6. Navigate to `localhost:8000 <http://localhost:8000/>`__ to use Taguette!
6. Navigate to `localhost:7465 <http://localhost:7465/>`__ to use Taguette!
Getting Started
---------------
After starting Taguette, you can interact with it through your web browser (`localhost:8000 <http://localhost:8000/>`__ should have opened automatically). You will see a page that greets you and has a button to **Start a new project**. Click that button and you'll be prompted to enter a **Title and Description** for your new project. This can be changed later if you want.
After starting Taguette, you can interact with it through your web browser (`localhost:7465 <http://localhost:7465/>`__ should have opened automatically). You will see a page that greets you and has a button to **Start a new project**. Click that button and you'll be prompted to enter a **Title and Description** for your new project. This can be changed later if you want.
Upon creating your project, you'll be taken the Project View, which has a left and a right pane. The left pane contains the information about your project information ('Project Info'), uploaded materials ('Documents'), and tags ('Highlights') as tabs. You can go between these tabs as you like. The right pane will render documents and be the area where you'll do the highlighting and tagging.
......
......@@ -148,7 +148,7 @@ class TestMultiuser(MyHTTPTestCase):
new=set_dumb_password):
self.application = web.make_app(dict(
main.DEFAULT_CONFIG,
NAME="Test Taguette instance", PORT=8000, DATABASE='sqlite://',
NAME="Test Taguette instance", PORT=7465, DATABASE='sqlite://',
EMAIL='[email protected]',
MAIL_SERVER={'host': 'localhost', 'port': 25},
MULTIUSER=True,
......@@ -225,7 +225,7 @@ class TestSingleuser(MyHTTPTestCase):
new=set_dumb_password):
self.application = web.make_app(dict(
main.DEFAULT_CONFIG,
NAME="Test Taguette instance", PORT=8000, DATABASE='sqlite://',
NAME="Test Taguette instance", PORT=7465, DATABASE='sqlite://',
EMAIL='[email protected]',
MAIL_SERVER={'host': 'localhost', 'port': 25},
MULTIUSER=False,
......@@ -251,6 +251,7 @@ class TestSingleuser(MyHTTPTestCase):
self.assertEqual(response.code, 404)
# Register: fails
# FIXME: This actually fails because of missing XSRF cookie
response = self.post(
'/register', dict(login='tester',
password1='hacktoo', password2='hacktoo'))
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment