The online platform where users can create an account, and explore the books that are available in the library.
- This application is a library platform for SJSU students to explore and find their favorite books.
- We wrote this application in hopes to make SJSU more connected through this app exclusively for students.
- IDE such as Ubuntu(WSL) or VSCode
- Python (3.10 or above)
- Flask
- SQLAlchemy
- flask-wtf
- flask-login
- flask-sqlalchemy
- flask-migrate
- Custom account creation
- Easy to reach other pages
- Search for your favorite books
- Check out and return books with ease
- Purchase from the shop's inventory
- Login
- Logout
- Create new account
- Delete account
- User home page
- Search for books
- Explore shops
- View announcements
- User profiles
- Manage users, books, shops, and databse (Admin and Librarian only)
- Help page
Start by cloning myProject:
git clone https://github.com/MichaelXiao9625/CMPE132Project.gitAfter cloning the project and ensuring that all the required libraries are installed, run the following command to start the server:
python run.pyThe first step to using our platform is to create an account, without an account the user cannot login to access anything beyond the base page. The password and e-mail must satisify certain guidelines in order for the account creation to be successful. After creating an account, the user's data will be stored into the database. The user then goes to login page to enter their login information, if it’s within the database the website will reroute them to the home page. From the home page user will be able to access all sorts of information such as announcements, book inventory, and profile.
As an admin and librarian, they can manage users and delete certain users. Librarians cannot delete admins, but admins can delete librarians. Admins and librarians can also manage book inventory and choose to add/delete books. From the 'Manage Users' tab, the admin and librarian can also view every users profile. IF they visit a students profile, they can see what book they have checked out.
The user can choose to update their bio and other user account information on the profile page, where the bio must adhere to certain guidelines. The user can choose to delete their account on their profile page by clicking the Delete Account option, followed by entering their password to ensure their removal from the database. Finally, if the user decides to logout, the button will be on the left column of the website, which would direct them back to the base page of our website.
As a student, to checkout a book the user would navigate to the 'Browse Books' tab using the sidebar. From there, the user is provided with a list of books in the book inventory and their availability. The user can then click on the 'Checkout' button to checkout the book. Similarly, the user can also return the book by clicking on the 'Return' button. To view what books the user has checked out, the user can navigate to the 'My Books' tab using the sidebar. From here, the user can also click on the 'Return' button to return the book from this page.
Our website also allows access to guests, who can view the base annoucement page, browse book inventory, and the help page. However, as a guest they cannot checkout/return books, only to view what books are in inventory and are avaialable. The help page also provides information on how to use our website, and the base page provides a brief announcment created by the admins.
- Michael Xiao (@MichaelXiao9625)