Repository for the miniproject
https://docs.google.com/document/d/15vqCODRXUYO3Vsodsao47D3_4svnRYiBmM0Al0pvP08/edit?usp=sharing
https://docs.google.com/spreadsheets/d/17_ErdDH1jxFkODuv1_hyGJekEFNDRP_3ufEJWUNcTP8/edit?gid=0#gid=0
Create a new folder and clone the repository:
$ git clone git@github.com:KaEerola/IceLime.git
Create a .env file inside the repository directory with the database url.
DATABASE_URL=postgresql:///{user}TEST_ENV = trueSECRET_KEY={secret_key}
Set up the environment inside the repository:
-
$ poetry install -
$ poetry shell
Start PostgreSQL and run the database setup:
$ python3 src/db_helper.py
Now start the server:
$ python3 src/index.py
Server should start in the address:
Once you start the program you arrive at the app main page.
There you have the option to either add a new reference or go to view the references you have added so far.
You can add three types of BibTeX references, books, articles and inproceedings.
Each reference type has a different amount of required and optional fields.
You can fill out the fields manually, or if you have it, you can use the Digital Object Identifier (DOI) to automatically import some of the fields.
You can also modify and add more information before submitting when using the DOI import if you so wish.
When you have added references, you can see them listed in the View References -page.
You can edit and delete the references you currently have.
You can export the references into a .bib file where they are formatted following common BibTeX style, which allows you to import the file directly into your LaTeX project without any further modifications.
The majority of the tests are robot tests. Unittest coverage report can be found at Codecov: https://app.codecov.io/gh/KaEerola/IceLime
There is a button on the main page that takes the user to the page for adding a new reference. From there, the user can click a link to add a new book reference. This takes the user to a page with the appropriate number of text fields (author, title, publisher, year). When the user has put in the proper values, they can add the reference to the database by clicking the add-button. If the user tries to add a year that hasn't come yet, or leaves fields empty, there is an error message.
There is a button on the main page that takes the user to the page for viewing the references that are currently in the database. This takes the user to a page titled "view your references", where each reference (currently just the book references) are gathered from the database and shown in a list.
There are two new types of references that can be added, articles and inproceedings. Adding work like in adding book reference.
There is a button on the view_reference page that creates a bibtex file. A .bib file yet can create only references for books.
There are optional input fields in the different types of references. User can choose which optional fields they want to fill out. If the fields are filled out correctly the user will get a message that the reference was added successfully. If the required fields are empty or year isn't correct the user will get an error message.
Application has now ability export inproceedings and article reference types into bibtex file. It can be done through a button in view_reference page.
In view_reference window is button "Edit a reference" clicking which user can choose reference he or she want to edit. It shows all fields of the reference and user can add or erase information.
In view_reference window is button "Remove a reference" clicking which user can choose certain reference from articles, inroceedings and books. By clicking submit button, user removes reference from references.
In every page where you are adding references. There is add DOI field where you can paste links of page of reference you want to add. It will automaticly fulfill input fields with reference information.
The application now has a navigation bar at the top, where the user can move to the different windows.
When adding a new reference, the user is required to choose a unique key for the reference. This key is used to identify the reference in several other places (when actually using the references to cite in text).
When the user adds a reference, they can input multiple authors into the fields. They can also do this when editing a reference. User can dynamically increase or decrease the amount of authors in the input form using + and - buttons.
When the user adds a reference, they can input multiple editors into the fields. They can also do this when editing a reference. User can dynamically increase or decrease the amount of editors in the input form using + and - buttons. In the case of adding a book, there is a possibility for the user to only have editors instead of authors.
The user has a great time when navigating through the application.
