Django CiteIt

This app displays an annotated bibliography and allows the viewer to sort by different criteria such as scope, author, year, etc.

Requirements

• Django 4.2
• Python 3.8 - 3.10

Installation

1. Download and install from source code.

   $ pip install git+git://github.com/unt-libraries/django-citeit.git

2. Add app to INSTALLED_APPS.

   INSTALLED_APPS = (
           'citeIt',
       )

3. Include the URLs.

   urlpatterns = [
           path('admin/', admin.site.urls),
           path('withers/', include('citeIt.urls'))
       ]

4. Migrate/sync the database

   $ python manage.py migrate

Developing

1. Clone the git repository:

       $ git clone https://github.com/unt-libraries/django-citeit.git

2. Navigate into the cloned repository:

       $ cd django-citeit

3. Install the requirements (preferably in a virtual environment):

       $ pip install -r requirements-dev.txt

4. Run the migrations:

       $ ./manage.py migrate

5. Create a superuser so you can log into the admin interface

       $ ./manage.py createsuperuser

6. Start the test server:

       $ ./manage.py runserver

   The test server can be viewed from a browser by navigating to the default location: http://localhost:8000/withers

Testing

1. Run the tests using tox

       $ pip install tox
   
       $ tox

License

See LICENSE

Contributors

• Mark Phillips
• Gio Gottardi
• Madhulika Bayyavarapu