wpater / book-project Goto Github PK

Book tracker web app made using Spring Boot and Vaadin 14 (only the free components will be used).

Features:

• Add books that you have read to a 'to read', 'currently reading', 'read' or 'did not finish' shelf
• View books in your different shelves and make changes
• A rating scale from 0-10 that that goes up in steps of 0.5
• Track your progress towards a reading goal: the number of books or pages you hope to read by the end of the year
• Statistics about your reading habits
• Add your own shelves
• Export your saved data to JSON
• And much more!

Coming soon:

• User registration and accounts
• And much more!

The images above may look slightly different to the app. If major changes are made, new images will be uploaded to reflect this.

Prerequisites:

• JDK 11 (the app currently won't work on later versions due to an issue with one of the libraries -- Karibu testing -- not being compatible with later versions)
• If you don't have Node.js installed globally, it is not needed as Vaadin will install it automatically
  • If you do have Node.js installed, please ensure it is at least version 10.0
• MySQL 8.0.* or (better) Docker
  • Windows or macOS: install Docker Desktop
  • Linux: install Docker Engine and Docker Compose

If you want to use Docker, follow one of the two appoaches (if you use Windows, follow the first approach):

1. Clone the repository
2. Import the project as a maven project into your favourite IDE (or run maven on the terminal)
3. Build the project at the root using ./mvn clean install (Unix) or mvnw.cmd clean install (Windows)
4. Start MySQL database using docker-compose up -d mysql phpmyadmin
5. Start the application using java -jar target/book-project-0.0.1-SNAPSHOT.jar
6. Log in with the details below:
   • Username: user
   • Password: password

1. Clone the repository
2. Import the project as a maven project into your favourite IDE (or run maven on the terminal)
3. At the root of the project, build the project in production mode using one of the following commands. In production mode all UI components are packaged in a jar file.
   • ./mvnw clean package -Pproduction (Unix), or
   • mvnw.cmd clean package -Pproduction (Windows)
4. Start the MySQL Database and book project app using docker compose docker-compose up --build
5. Go to localhost:8080
6. Log in with the details below:
   • Username: user
   • Password: password

You may find lots of errors for things like the log statements, or the entities not having constructors. You can find instructions on how to fix this for IntelliJ and Eclipse in our troubleshooting wiki page. Other common errors and solutions are also detailed in the troubleshooting page.

To access the MySQL database when docker-compose is running:

1. Go to http://localhost:8081/
2. Log in with the settings below.
   • User Name: root
   • Password: rootpassword
3. Click on connect

If you wish to contribute (thanks!), please first see the contributing document.

For more information, such as a roadmap and the underlying principles of the project, see the Book Project wiki.

If you need help with anything, we'll be happy to help you in our Slack workspace.

Project Lombok - MIT License

Karibu Testing - Apache 2.0 License

Mockito - MIT License

AssertJ - Apache 2.0 License

zxcvbn4j - MIT License

paper-toggle-button - BSD-3 clause

jackson - Apache 2.0 License