W3Schools Database in Docker

Forked from https://github.com/AndrejPHP/w3schools-database for academic purposes.

This repository provides:

• a docker compose which sets up the DB on port 3309 (non-default, no clashes)
• initializes the database data from w3schools (provided by @AndrejPHP)
• Visual Studio Code config

Prerequisite

Make sure that the following software is installed:

• Docker
• If you are on Windows, please use WSL with Ubuntu for the setup and use the bash terminal

Fork to your github account

Go to github.com, create a new account or login.

• Fork this repo (https://github.com/ibuenuel/w3schools-database.git)

Now you have a repository w3schools-database in your github account. Clone that with:

git clone https://github.com/YOURUSERNAME/w3schools-database
cd w3schools-database
code .

Run the database and rest-api

sudo docker compose up

Start the react app

cd my-app
npm install
npm start

How to reset?

Execute:

docker compose down
rm -rf data
docker compose up -d

Tables

When the docker container starts, it creates database named w3schools with the following tables

categories
customers
employees
orders
order_details
products
shippers
suppliers

and inserts the respective data.

Features

1. Get and list all Products
2. Get and list all Categories
3. Get and list all Suppliers
4. Create a new Product
5. Create a new Categorie
6. Create a new Supplier
7. Update an existing Product
8. Update an existing Categorie
9. Update an existing Supplier
10. Delete a Product
11. Delete a Categorie
12. Delete a Supplier
13. Filter by Category or Supplier (If its provided, to test see Products Page)
14. Search Entity by Name
15. Reset Filters and Search Term with a Button
16. Sort by Entity Fields
17. Pagination of the Table

Journal

14.09.2024

The project setup was quite challenging, but I was able to install it successfully using WSL. VirtualBox used too much RAM and the VM froze a lot, so I switched to WSL.

28.10.2024

Made some reasearch about routing and added routing functionality to the application. Added the needed Features as follows:

• 3 Entities will be shown with the GET Method (Products, Categories, Suppliers)
• Creating of 3 different Entities with POST Method is working (Products, Categories, Suppliers)
• Update of 3 different Entities with PATCH Method is working (Products, Categories, Suppliers)
• Delete of 3 different Entities with the DELETE Method is working (Products, Categories, Suppliers)
• Added new Feature Filtering (Filter Entities)
• Added Feature Pagination
• Added Sort function (click table head)

Wrote the technical documentation, documented the features in Markdown and updated the journal.