Merge pull request #1 from ReCoded-Org/dockerizing

Feat: Dockerized

Author: Ammar-64

.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log

Dockerfile

@@ -0,0 +1,10 @@
+# syntax=docker/dockerfile:1
+
+FROM node:18-alpine
+WORKDIR /app
+COPY . .
+RUN npm install
+EXPOSE 3000
+COPY entry.sh ./entry.sh
+RUN chmod +x ./entry.sh
+CMD ["./entry.sh"]

README.md

@@ -1,10 +1,147 @@
 # Sequelize Practice
+
 The objectives of this assignment are:
+
 1. Understanding the use of an ORM
 2. Executing queries on a MySQL database using Sequelize
 
-## Getting Started
+## Docker Version Instructions
+
+This lab is Dockerized, so it has all the packages and dependencies already installed and containerized, when you compose it, it will come with all the packages installed and configured inside.
+
+Imagine it like a small virtual machine, everything is set and ready, you just need to write code for the solutions and starting the database is slightly different. We do this for you students to not encounter possible errors related to your development environment.
+
+You will find additional instructions after this section so you can also learn how to install the dependencies and start your database in a non-dockerized environment.
+
+Follow these instructions to get the app ready:
+
+1. Start your Docker app on your desktop.
+2. Run the command `npm run start` to build docker images. It might take some time, what this command does is it installs all the needed and pre-configured packages like `mysql2` and `sequelize` and starts and creates a database named `practice` that you otherwise would need to install/configure yourself. You can check your Docker app after it is done and you would see that Docker created 2 images and connected (_bound them together_) them after it's done you can run `npm run verify` to make sure that the container has been built correctly.
+
+Ta-da, we are ready to work on the assignment now.
+
+### Sequelize Database Connection
+
+First, let's create a connection to our practice database and test it out.
+
+In the assignment folder, you will find a file called `connect.js`. Enter these lines of code here.
+
+```js
+const Sequelize = require("sequelize");
+
+const path = "mysql://root:secret@db:3306/practice";
+const sequelize = new Sequelize(path);
+
+sequelize
+  .authenticate()
+  .then(() => {
+    console.log("Connection established successfully.");
+  })
+  .catch((err) => {
+    console.error("Unable to connect to the database: ", err);
+  })
+  .finally(() => {
+    sequelize.close();
+  });
+```
+
+**Note:** If you'd check the `compose.yaml` file, you can see that `root` is the name of our user, `secret` is the name of our password, `3306` is our port and `practice` is the name of our database. Unlike the normal setup, we don't need to change anything here.
+
+Now let's run this file: `npm run execute connect.js`. You should see the output as :
+
+```
+[+] Building 0.0s (0/0)
+docker:default
+[+] Building 0.0s (0/0)
+docker:default
+Executing (default): SELECT 1+1 AS result
+Connection established successfully.
+```
+
+From this piece of code, you can tell the following:
+
+1. Sequelize requires a MySQL connection path that contains the username, password, hostname, database port and database name.
+2. The authenticate method tests the connection by trying to authenticate to the database. We show a message when the connection is established OK.
+3. In case of an error, we show an error message.
+4. In the end, we close the database connection.
+
+### Sequelize Model Definition
+
+A Model represents a table in the database. Let's create a model representing a table called todo for a todo list application.
+
+In the assignment folder, you will find a file called `model.js`. Enter these lines of code here.
+
+```js
+const Sequelize = require("sequelize");
+
+const path = "mysql://root:secret@db:3306/practice";
+const sequelize = new Sequelize(path);
+
+// The table will have a column called description of type string
+const Todo = sequelize.define("todo", {
+  description: Sequelize.STRING,
+});
+
+Todo.sync()
+  .then(() => {
+    console.log('New table "todo" created');
+  })
+  .catch((err) => {
+    console.error("Unable to create table: ", err);
+  })
+  .finally(() => {
+    sequelize.close();
+  });
+```
+
+Once again, run `npm run execute model.js`. You should see the query being executed in the output and the todo table will be created.
+
+## Practice Time
+
+Now that we have written some code utilizing Sequelize, let's explore some more of what can be achieved through this ORM by performing some more operations on our Todo table.
+
+In this assignment folder, you will find the following files:
+
+```
+insert_todo.js
+find_by_id.js
+multi_insert_todo.js
+find_one.js
+count_rows.js
+update_row.js
+delete_row.js
+order_by.js
+```
+
+In each file, you will find a comment describing an SQL operation to be done using Sequelize. You must write the required code for each operation in these files one by one.
+
+Note: You will have to add the SQL connection and model definition on each file since we will be running each file independently. Example: `npm run execute insert_todo.js`
+
+Refer to the [Sequelize documentation](https://sequelize.org/) for support.
+
+## Note 
+
+Run `npm run stop` to stop docker and `npm run reset` in case anything goes wrong and you need to start from scratch
+
+
+## Submission
+
+Once you're ready to submit the assignment, follow these steps on your terminal:
+
+1. Stage your changes to all the JS files to be committed: `git add .`
+2. Commit your final changes: `git commit -m "solve assignment"`
+3. Push your commit to the main branch of your assignment repo: `git push origin main`
+
+After your changes are pushed, return to this assignment on Canvas for the final step of submission.
+
+## Conclusion
+
+So far we know how to directly execute queries on a MySQL database. This assignment gave us the chance to work with a MySQL database using Node.js. Of course, we will not be writing separate files for each operation in our actual projects. When building a CRUD API, we will simply execute the Sequelize functions within our API endpoint handlers depending on the required operation. All of this coming soon in Module 3, so stay tuned!
+
+## Non-Docker Version Instructions
+
 Follow these installation instructions to install MySQL on your computer.
+
 1. [Install MySQL on WSL or Linux](https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-database#install-mysql)
 2. [Install MySQL on MacOS](https://flaviocopes.com/mysql-how-to-install/)
 
@@ -23,73 +160,89 @@ Let's create a database for practice. Enter the query: `create database practice
 Once our practice database is created, we can exit the prompt: `exit`
 
 ### Sequelize Setup
+
 Sequelize is available via npm. Navigate to your cloned assignment folder and run the command: `npm install sequelize`
 
 To use sequelize on a Node.js project, we will also have to install the database driver, so run the command: `npm install mysql2`
 
-### Sequelize database connection
+### Sequelize Database Connection
+
 First, let's create a connection to our practice database and test it out.
 
 In the assignment folder, you will find a file called `connect.js`. Enter these lines of code here.
+
 ```js
-const Sequelize = require('sequelize');
+const Sequelize = require("sequelize");
 
-const path = 'mysql://root:yourpassword@localhost:3306/practice';
+const path = "mysql://root:yourpassword@localhost:3306/practice";
 const sequelize = new Sequelize(path);
 
-sequelize.authenticate()
-    .then(() => {
-        console.log('Connection established successfully.');
-    }).catch(err => {
-        console.error('Unable to connect to the database: ', err);
-    }).finally(() => {
-        sequelize.close();
-    });
+sequelize
+  .authenticate()
+  .then(() => {
+    console.log("Connection established successfully.");
+  })
+  .catch((err) => {
+    console.error("Unable to connect to the database: ", err);
+  })
+  .finally(() => {
+    sequelize.close();
+  });
 ```
+
 **Note**: Add your MySQL password in the path for the database connection, by replacing `yourpassword`.
 
 Now, let's run this file: `node connect.js`. You should see the output as:
+
 ```
 Executing (default): SELECT 1+1 AS result
 Connection established successfully.
 ```
 
 From this piece of code, you can tell the following:
-1. Sequelize requires a MySQL connection path which contains the username, password, the host name, database port and database name.
-2. The authenticate method tests the connection by trying to authenticate to the database. We show a message when the connection was established OK.
+
+1. Sequelize requires a MySQL connection path that contains the username, password, hostname, database port and database name.
+2. The authenticate method tests the connection by trying to authenticate to the database. We show a message when the connection is established OK.
 3. In case of an error, we show an error message.
 4. In the end, we close the database connection.
 
 ### Sequelize model definition
+
 A Model represents a table in the database. Let's create a model representing a table called `todo` for a todo list application.
 
 In the assignment folder, you will find a file called `model.js`. Enter these lines of code here.
+
 ```js
-const Sequelize = require('sequelize');
+const Sequelize = require("sequelize");
 
-const path = 'mysql://root:yourpassword@localhost:3306/practice';
+const path = "mysql://root:yourpassword@localhost:3306/practice";
 const sequelize = new Sequelize(path);
 
 // The table will have a column called description of type string
-const Todo = sequelize.define('todo', {
-    description: Sequelize.STRING
+const Todo = sequelize.define("todo", {
+  description: Sequelize.STRING,
 });
 
 Todo.sync()
-    .then(() => {
-        console.log('New table "todo" created');
-    }).catch(err => {
-        console.error('Unable to create table: ', err);
-    }).finally(() => {
-        sequelize.close();
-    });
+  .then(() => {
+    console.log('New table "todo" created');
+  })
+  .catch((err) => {
+    console.error("Unable to create table: ", err);
+  })
+  .finally(() => {
+    sequelize.close();
+  });
 ```
-Once again add your password in the connection path and then run `node model.js`. You should see the query being executed in the output and the todo table will be created. You can even verfy this on the MySQL Prompt.
+
+Once again add your password in the connection path and then run `node model.js`. You should see the query being executed in the output and the todo table will be created. You can even verify this on the MySQL Prompt.
 
 ## Practice Time
-Now that we have written some code utilizing Sequelize, let's explore some more of what can be acheived through this ORM by performing some more operations on our Todo table.
+
+Now that we have written some code utilizing Sequelize, let's explore some more of what can be achieved through this ORM by performing some more operations on our Todo table.
 
 In this assignment folder, you will find the following files:
+
 ```
 insert_todo.js
 find_by_id.js
@@ -100,19 +253,23 @@ update_row.js
 delete_row.js
 order_by.js
 ```
+
 In each file, you will find a comment describing an SQL operation to be done using Sequelize. You must write the required code for each operation in these files one by one.
 
 Note: You will have to add the SQL connection and model definition on each file, since we will be running each file independently.
 
 Refer to the [Sequelize documentation](https://sequelize.org/) for support.
 
 ## Submission
+
 Once you're ready to submit the assignment, follow these steps on your terminal:
+
 1. Stage your changes to all the JS files to be committed: `git add .`
 2. Commit your final changes: `git commit -m "solve assignment"`
 3. Push your commit to the main branch of your assignment repo: `git push origin main`
 
 After your changes are pushed, return to this assignment on Canvas for the final step of submission.
 
 ## Conclusion
-So far we knew how to directly execute queries on a MySQL database. This assignment gave us the chance to work with a MySQL database using Node.js. Of course we will not be writing separate files for each operation in our actual projects. When building a CRUD API, we will simply execute the Sequelize functions within our API endpoint handlers depending on the required operation. All of this coming soon in Module 3, so stay tuned!
+
+So far we know how to directly execute queries on a MySQL database. This assignment gave us the chance to work with a MySQL database using Node.js. Of course, we will not be writing separate files for each operation in our actual projects. When building a CRUD API, we will simply execute the Sequelize functions within our API endpoint handlers depending on the required operation. All of this coming soon in Module 3, so stay tuned!

compose.yaml

@@ -0,0 +1,24 @@
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    entrypoint: ["./entry.sh"]
+    ports:
+      - "3000:3000"
+    environment:
+      MYSQL_HOST: mysql
+      MYSQL_USER: root
+      MYSQL_PASSWORD: secret
+      MYSQL_DB: practice
+  db:
+    image: mysql:latest
+    volumes:
+      - mysql_data:/var/lib/mysql
+    environment:
+      MYSQL_ROOT_PASSWORD: secret
+      MYSQL_DATABASE: practice
+    ports:
+      - "3307:3306"
+volumes:
+  mysql_data:

connect.js

@@ -1 +1 @@
-// Enter your code below
+// Enter your code below

count_rows.js

@@ -1,2 +1,2 @@
 // Use Sequelize to count the number of rows in the todo table
-// Enter your code below
+// Enter your code below

delete_row.js

@@ -1,3 +1,3 @@
 // Use Sequelize to delete a row in the todo table
 // For example, delete the todo with description: Watch Netlfix
-// Enter your code below
+// Enter your code below

entry.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# Check if a script name is provided as an argument
+if [ -n "$1" ]; then
+  node "$1"
+else
+  echo "No script specified."
+fi

find_by_id.js

@@ -1,2 +1,2 @@
 // Use Sequelize to find a row in the todo table by ID
-// Enter your code below
+// Enter your code below

find_one.js

@@ -1,3 +1,3 @@
 // Use Sequelize to find the first row where description includes the word 'Visit'
 // Try to use async/await instead of promises this time
-// Enter your code below
+// Enter your code below

insert_todo.js

@@ -1,2 +1,2 @@
 // Use Sequelize to insert a new row in the todo table
-// Enter your code below
+// Enter your code below

model.js

@@ -1 +1 @@
-// Enter your code below
+// Enter your code below

multi_insert_todo.js

@@ -2,12 +2,12 @@
 // Insert the values from given array below
 
 const todosToInsert = [
-    { description: 'Tai chi in the morning' },
-    { description: 'Visit friend' },
-    { description: 'Visit grocery store' },
-    { description: 'Listen to music' },
-    { description: 'Watch Netlfix' },
-    { description: 'Walk for an hour' }
+  { description: "Tai chi in the morning" },
+  { description: "Visit friend" },
+  { description: "Visit grocery store" },
+  { description: "Listen to music" },
+  { description: "Watch Netlfix" },
+  { description: "Walk for an hour" },
 ];
 
-// Enter your code below
+// Enter your code below