Skip to content

Eleven Fifty Academy Software Development Red Badge Project

Notifications You must be signed in to change notification settings

adamkr13/BiblioCat

Repository files navigation

BiblioCat

Eleven Fifty Academy Software Development Red Badge Project

Version

Version 1 was published with Azure on May 10, 2021.

BiblioCat

Introduction

BiblioCat is a Web Application to aid in the crowdsourced tracking and managing of information about your favorite Authors, Books, Publishers, Series, and Conventions. With the current design, the user may create, edit, update, and delete (Authors, Books, Publishers, Series, and Conventions). Then, once those items are created, they may be added/connected to each other through specific menus dedicated to that purpose.

In the remainder of this ReadMe, an "object" is a reference to a specific Author, Book, Series, Publisher, or Convention.

Installing / Getting started

There are not any installation requirements.

Usage

Register and Login

Upon initially visiting the site, you will be taken to a page to register or login.

Front Page

To Register, fill out the below fields. Your password must be at least six characters, contain an uppercase character, a lowercase character, a digit, and a non-alphanumeric character. The registration process automatically logs you in.

Register Page

If you are returning to the site after already registering, go to the Log in Page and fill enter your information there.

Login page

Navigation

Once logged in, you will be taken to the front page where you will have the option of using the navigation bar at the top

Nav Bar

or the buttons in the main section of the page

Main Page

to navigate to the Author, Book, Series, Publisher, and Convention pages where you will be able to manipulate those items.

On any page, you can use the navigation bar on the top to go to a specific list page.

If you are using a device with a narrower screen, you can reveal these NavBar options by clicking on the hamburger menu on the top right of the screen.

Hamburger Menu

Logout

At any point, if you want to log out of BiblioCat, click on "Log Off" in the upper right portion of whichever page you are on.

Log off

Again, if you are on a narrower screen, the Log off option can be accessed by clicking on the hamburger menu as described above.

Adding an Author, Book, Series, Publisher, or Convention

Here is an example of a list page.

List Page

Click on the Add (Author, Book, etc) Button and you will be taken to a page to enter the information for that object.

From that page, you can enter the information and click the Create Button to Create the new object or you can go back to the list page.

Add Author

Object Options

On the list page (see example above), on the right of the object, there is a menu of options that pertain to that specific object.

Object Options

Editing an Object

On the list page, clicking on "Edit" takes you to the object edit page where you can edit the information for that object and save the changes or go back to the list page without saving the changes.

Object Options

The Details Page

Click on "Details" takes you to the object details page where you can view information about that object that may not be shown in the list page. This page also has all of the options available for each object in the list page as well as a button to go back to the list page.

Author Detail

Deleting an Object

On the list page, clicking on "Delete" takes you to the object delete page where you can delete an object. Clicking on "Delete" will delete the object.

Author Delete

Connecting Objects

  • For this example we will be adding books to an author. This process is the same for any of the connections that may be made with these objects with the exception of adding Publishers.

Once you have added, as an example, an author and a book, you may connect these two objects.

On the list page, in the menu to the right of the object of interest, click on the thing you want to do. In this case, it is "Add Books".

That will take you to a page where you may select from a list of all the books and add them to the author. Select the books you want to add by clicking on their check box and then click "Add Books" and they will be added to the Author.

Add Books To Author

Adding Publishers to Authors and Books

In order to add Publishers to Authors or Books, it is necessary to go to the Author or Book Detail Page. From there, in the bottom menu, click "Add Publishers to Author (or Book)" and you will be taken to the page to add publishers similar to that described in the Connecting Objects section above.

Add Publishers To Author

Removing Connections

Similar to adding connections, if you want to remove books from an author, in the list page click on "Remove Books from Author", select the books that you want to remove, and click "Remove Books".

Known Issues

  • Adding and removing connections

It is currently possible to, for example, add books to an author that have already been added to that author. Doing this will cause an error. Similarly, it is currently possible to remove books from an author that are not connected to that author. This will also cause an error.

  • Implementation of owner book properties

Currently, as mentioned in the introduction, this application is envisioned as a crowd sourced database. While properties for books include options for "I Have Read It" and "I Own It", there is not currently functionality to distinguish between individual users. So these fields will read the same for all users and be the values as applied during the creation of the book or during the most recent edit of the book properties.

Resources

About

Eleven Fifty Academy Software Development Red Badge Project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published