EfiLibrary is a project between the students of Business Information Technology Degree Programme in Haaga-Helia University of Applied Sciences, and Eficode Oy, a Finnish company specializing in enhancing software development, whose products are related to automation and devops consulting, as well as accessibility and user studies.
This digital library project is the transformation of the many physical copies of books owned by Eficode and scattered in different Eficode offices located in 10 different countries around the world, into one digital library in which the various users will be able to learn-from, teach-with, and enjoy sharing knowledge easily and efficiently.
The users will be able to loan, reserve, and return books, create lists of favorite books and watch other users' favorite lists, as well as like and review books, and browse through the library database.
Admins will be able to control the distribution of borrowed books and monitor the users' activity within the library on a restricted admin page. Admin users can view users, books, loans, reservations, and requests. Admin users can also edit and delete users, and generate a password reset link if need be. In addition, admin users can deny, allow, or cancel book requests and reservations in the restricted admin page.
The EfiLibrary project was created and built from the ground up and in its entirety by the students of Haaga-Helia UAS for the use of Eficode Oy.
Knowledge is power.
Efilibrary consists of a frontend and a backend with a connected relational database. Both front- and backend are written in TypeScript and are using React and Express respectively as their main framework and library.
The frontend’s user interface is divided into pages that are routed through react-router-dom. To access pages other than the login page or # page, users can create accounts and securely log in in through HTTPS with passwords that are hashed on server-side. Authentication is implemented using Bearer Tokens.
Make sure that the
REACT_APP_BACKEND_URLin the frontend.envmatches the port in the backend.env. Or if you're using docker-compose, the port in the docker-compose file.
You need to have npm installed to run this project, you can check if you have it installed by running npm -v in the command line.
Clone the repository on your computer. Detailed instructions can be found here.
Use npm ci or npm install to install node modules.
npm startThis runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload when you make changes to the code.
You will also need the backend running for the application to work.
- Install Docker and Docker Compose on your machine. Docker Installation Guide. If you choose to use Docker Desktop, which is recommended, it comes with Docker Compose preinstalled.
- To run the frontend with docker-compose, you need to create a .env file in the root of the frontend project.
If you want to run just the frontend part of the application, follow these steps:
- Open a Terminal: Open your command-line interface (CLI).
- Navigate to Frontend Directory:
The docker-compose-start-frontend.ymlis located at the root of the frontend directory. Use thecdcommand to navigate:cd path/to/library-project-frontend - Now run the command (windows users make sure you have docker desktop running):
docker-compose -f docker-compose-start-frontend.yml up -d
Make sure the backend is running before next steps. You can check if the backend is running here: http://localhost:3002/health It should say: "ok: true"
- Now with both backend and frontend running, open the app at http://localhost:3000/
You have the option to start both the frontend and backend (including the database) using a single command from the frontend directory. This is done through the docker-compose-start-front-and-back.yml file, which pulls the backend image from our GitHub Container Registry and starts it along with the frontend as containers.
Follow these steps to run both the frontend and backend from the frontend directory:
- Open a Terminal: Open your command-line interface (CLI).
- Navigate to Frontend Directory:
The docker-compose-start-front-and-back.ymlis located at the root of the frontend directory. Use thecdcommand to navigate:cd path/to/library-project-frontend - Now run the command (windows users make sure you have docker desktop running):
docker-compose -f docker-compose-start-front-and-back.yml up -d
Check Backend Status: Ensure the backend is fully operational before continuing. You can check if the backend is running here: http://localhost:3002/health It should display: "ok: true"
- Now with both backend and frontend running, open the app at http://localhost:3000/
Note: It might take few minutes for the frontend to be completely ready for use.
See detailed documentation about Robot testing in AboutRobotTests.md documentation file.
- On Pushes to
development: Whenever code is pushed to thedevelopmentbranch, the workflow starts. - On Pull Requests to
development: It also starts when someone proposes changes (pull requests) to thedevelopmentbranch.
- Gets the Latest Code: It first grabs the most recent version of frontend code from GitHub.
- Logs into Docker Registry: It logs into a GitHub Container Registry (GHCR). This is where we store our Docker images.
- Builds and Starts Our App: Using a Docker Compose, it builds applications and start them up. Backend is pulled from ghcr and frontend is build from the pushed local files.
- Waits for Everything to be Ready: The workflow makes sure that both the backend and frontend are properly set up and ready to go.
- Runs Frontend Tests: It runs a series of checks on the frontend to make sure everything works as expected.
- Cleans Up: Finally, it shuts everything down and cleans up, ensuring that we're starting fresh the next time.
- Secrets and Settings: This workflow uses GitHub secrets that are passed as .env for the docker-compose.
- No Manual Work Needed: This entire process is automatic.
The Prettier workflow is setup in the code with Pretty-quick (https://github.com/azz/pretty-quick) and Husky (https://typicode.github.io/husky/) to ensure consistent foramtting. Pretty-Quick checks formatting when a developer tries to commit to the repo, and fixes formatting using our prettier config (.prettierrc.json file in the root of the project). Husky ensures that the pre-commit checks works with a pre-commit hook. Make sure you have all dependencies installed by running: npm install before you start. In your code editor, you can also set prettier checks on save, which will help the process.
Attribution in alphabetical order:
- Ville Aalto
- Christel Baker
- Sebastian Bergman
- Jordie Biemold
- Michael Brown
- Louis Diarra
- Raúl Fernández Poolan
- Lauri Iivarinen
- Jouni Johansson
- Eeli Killström
- Ivan Kolesov
- Amaru Korpimäki
- Markku Känkänen
- Samuel Langhoff
- Jong Lau
- Jasmin Lumme
- Aaro Miikkulainen
- Anja Miscevic
- Tatu Paukkeri
- Dung Pham
- Shay Pisanty
- Lauri Reis
- Juho Rintala
- Axel Riska
- Aleksi Saarinen
- Markus Sibakov
- Dmitry Sinyavskiy
- Julia Söderlund
- Elisa Tuovila
- Veeti Vainikka
- Riku Vartiainen
- Tia Venäläinen
- Palmitos254
See the project's MIT License in LICENSE.md