diff --git a/README.md b/README.md index 1e4fc64..28bf496 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,11 @@ this project sets the stage for a smooth and secure online book shopping experie * User Profile Management: Customize your literary journey with personalized settings. * Secure RESTful API Endpoints: Fortified endpoints, ensuring safe passage for data travelers. +## Demo video + +[![Video Title](/images/video_cover_image.png)](https://youtu.be/76rQ1n_4F8s) + + ## Installation 1. Clone the repository: @@ -46,20 +51,7 @@ this project sets the stage for a smooth and secure online book shopping experie git clone https://github.com/nklimovych/book-store.git cd book-store ``` -2. Configure the database: Create a new MySQL database: - ```sql - CREATE DATABASE bookstore; - ``` - Update the `application.properties` file with your MySQL database credentials: - ```properties - spring.datasource.url=jdbc:mysql://localhost:3306/bookstore - spring.datasource.username=root - spring.datasource.password=password - spring.jpa.hibernate.ddl-auto=validate - spring.jpa.show-sql=true - spring.jpa.open-in-view=false - ``` -3. Set Environment Variables: +2. Set Environment Variables: Create a `.env` file in the project root directory and populate it with the following environment variables: @@ -78,21 +70,16 @@ this project sets the stage for a smooth and secure online book shopping experie JWT_SECRET=JustAnotherSuperSecretString1234! JWT_EXPIRATION=3600000 ``` -4. Install dependencies and build the project: +3. Build and Run the Docker Containers: ```bash - mvn clean install + docker-compose up --build ``` -5. Build and Run the Docker Containers: +4. Access the Application: - ```bash - docker-compose up - ``` -6. Access the Application: - - Open your browser and go to `http://localhost:8080/api/swagger-ui/index.html#/` + Open your browser and go to http://localhost:8080/api/swagger-ui/index.html#/ to access the Swagger API documentation. -7. Stop and Remove Containers: +5. Stop and Remove Containers: To stop and remove the containers created by the Compose file, use the docker-compose down command: @@ -107,7 +94,7 @@ Explore the detailed API documentation generated by Swagger to understand the va and their functionalities.
-

How to Use Swagger for API Testing

+

How to Use JWT token to test endpoints with Swagger API (click to view)

Follow the next steps: