ikanher / categorized-bookmarks

Web application to store bookmarks in hierarchical categories.

Categorized Bookmarks

This repository is for Laboratory work for the course Introduction to databases at University of Helsinki.

Live

App is running live at Categorized Bookmarks

There's an administrator account 'admin' with password 'admin12'.

Description

Aki is a computer enthuastic. He has never been happy with browser bookmarks, they have too little structure to be useful. He would love to have a better system.

Ideally the system should be integrated to the browser and be stored in a centralized database. But just a web site is a good start.

To have better structure for browsing the bookmarks the system should provide categories. Bookmarks should have one or more categories and of course categories should contain many bookmarks.

Bookmarks should also be searchable. It would also be interesting to see some high-level information such as how many bookmarks does a category have.

Aki would be ecstatic if categories could also contain other categories as subcategories!

Documentation

Installation guide

User guide

User stories

Database schema

Running in Docker

categorized-bookmarks's Issues

Koodikatselmointi

Haettu 30.11.2018 klo. 17.50

Positiivisia kommentteja

• Koodin luettavuus on hyvällä tasolla
• Hyvät kommentit niissä kohdissa missä niitä oli. Selkeyttää koodiin tutustumista merkittävästi.
• Yleisesti muuttujilla ja metodeilla kuvaavat nimet.
• Näkymien kansiorakenne on järkevä.
• Erittäin siisti toteutus monen kategorian bookmarkiin liittämiselle.
• Hyvä, että kategoriaa poistettaessa ei poisteta bookmark.

Parannusehdotuksia

Pienet:

• Create nappi voisi olla hieman näkyvämpi, ehkä toisessa reunassa.
• Vaikka on aika tehokasta ja selkeää mitä yhden kirjaimen muuttujat b (bookmark) ja c (category), niin olisi hyvä pitää yhdenmukaisuus niin, että kaikki muuttujat ovat kuvaavasti nimetty. Esim. “user” muuttuja ei ole nimetty “u”...

Vähän suuremmat:

• Uuden käyttäjän rekisteröidyttyä olisi mukavaa kirjata sisään tämä käyttäjä, jotta sovelluksen käyttöönotto olisi sulavampaa.

• Olisiko käyttötarkoituksen perusteella hyvä tarkastaa että duplikaatti bookmark ei luoda samalle käyttäjälle saman kategorian alle? (Jos on tarkoitus tehdä bookmark ylläpito selkeämmäksi)

• Kun luo uuden bookmark niin on tällä hetkellä mahdollista luoda se ilman “text” kentän arvoa, joka voisi myös nimetä kuvaavammin, esim. title (koska on jo olemassa description). Tämä johtaa yhden kategorian bookmark listauksessa siihen, että ei ole olemassa tekstiä mihin kiinnittää linkki bookmarkiin.

• Jos bookmark määrä kasvaa ja poistaa joihinkin liittyvät kategoriat, voi olla vaikeaa löytää nämä bookmarkit ilman kategoriaa. Voisi siis lisätä filtteröinti että on kategoria “ilman kategoriaa” joka näkyy kategorioissa aina kun on olemassa bookmark ilman kategoriaa.

Koodikatselmointi 2

14.12.2018 klo 22:45.

##Yleistä

-Sovellusta voidaan pitää erinomaisena, eikä siihen yleisesti ottaen ole hirmuisen paljon kommentoitavaa. Tämän vuoksi monet ehdotukset alla voivat olla hieman nippeliin keskittyviä. Jokatapauksessa hienoa työtä!
-Sovellusta testattiin sekä valmiilla admin-käyttäjällä että luomalla useampi käyttäjä. Admin käyttäjällä testattiin skeä kirjanmerkkien että kategorioiden lisäämistä, poistamista ja muokkaamista. Sen lisäksi admin-käyttäjällä testattiin käyttäjätunnuksien poistamista. Molemmilla käyttäjillä kokeiltiin myös sisäänkirjautumisen toimivuutta.

##Dokumentaatio

-Erittäin hyvin tehty dokumentaatio, nähdäkseni dokumentaatio on kokonaisuudessaan kurssin laajuus huomioon ottaen erinomainen.
-Etenkin käyttäjäkuvaukset ja sovelluksen käyttöohjeet oli laadittu erinomaisesti!

##Toiminnallisuudet

-Tällä hetkellä kategoria sama kategoria voi olla sekä "parent" että "child" -kategoria samalle kategorialle. Onko tämä harkittu ominaisuus sovelluksessa? Itselleni ominaisuus tuntui hieman epätarkoituksenmukaiselta ja sekavalta. Lopulta kuitenkin makuasia.

##Ulkoasu

-Tämä on nähdäkseni myös lähinnä makuasia, mutta ulkoasu oli mielestäni ehkä hieman sekava uuden käyttäjän kannalta. Valtaosa sovelluksen tavarasta on selaimen yläosassa horisontaalisesti, mikä voi vähän heikentää käytettävyyttä. Koska toiminnallisuuksia on myös paljon, on kokonaisuus siksi sekavahko.
-Ehkä osa toiminnallisuuksista ja linkeistä voisi sijoittaa omiin "dropdown-menuihinsa" tai jotenkin muuten?
-Sovelluksessa oli esimerkiksi kaksi horisontaalista valikkoa. Voisiko toinen toimivampi ratkaisu olla sijoittaa nämä esimerkiksi vertikaalisesti tai keskemmälle?

##Errorit

-Onnistuin saamaan aikaan errorin poistaessani herokussa olevasta sovelluksesta käyttäjää "Demo". Muita käyttäjiä poistaessani admin-tunnuksilla en kuitenkaan saanut aikaan virheitä. Koodia tutkaillessani en saanut selville, mistä error johtuu, mutta olkoon ainakin tiedoksi.

##Muuta

-Koodi oli mielestäni kirjoitettu erinomaisesti, siinä oli esimerkiksi nähdäkseni vältetty hyvin esimerkiksi toistoa. Tästä hyvänä esimerkkinä toimii tiedosto "macros.html"