Idea Case "model project" for backend (exam, task etc.) learning, Express Version

This version uses Express. Now ready for studying!

Files to look at

from the model project idea-case-backend (most of the other files are either extra, obsolete or written some other way, do NOT look at them.)

• README.md (this file)
• package.json
• .env
• .gitignore
• src/index.js
• src/routes/api/index.js
• src/routes/api/category.js
  • GET /api/category/:id
    • get one by id : returns the object as JSON
  • GET /api/category
    • get all : returns the result set, that is an array of categories as JSON
  • DELETE /api/category/:id
    • delete one by id : returns how many rows were affected = deleted
  • PUT /api/category
    • updates one by the updated object including the id : returns number of rows affected = updated
  • POST /api/category
    • insert new one, data _excluding the id sent by client. returns the (auto-incremented?) id:s of the created objects in an array, like [101,102]
• src/db/index.js
• src/responseHandlers/index.js
• utils/logger.js
• logs/backendLog.log & logs/errorLog.log

Plus the Database design and creation, and Postman tests

There are of course then still some more files, like Database design and creation (SQL) docs in Database folder, and Postman test examples in the Postman folder. Look at them when you get to that level.

Table of Contents

• BACKEND TOOL SET
• Set up Database
• Set up ssh tunnel
• Quick overview
• Usefull links

BACKEND TOOL SET

• Git for Windows, including the Git Bash
• VS Code
• Node (including commands node, npm, npx, nodemon)
• (many node packages installed based on package.json, look at it and See below for npm install)
• Postman or VS Code Rest Client
• MariaDB
• DBeaver community edition. (Or MySQL Workbench community edition or HeidiSQL or ... ) (Not 100% necessary, only if want GUI SQL editor)
• ssh, for creating the SSH tunnel if needed. GitBash seemed to bring me ssh CLI command, maybe depends on install options

BACKEND INSTALLATION GUIDE

(((0. Have the SSH Tunnel to Maridb database defined so that finally it shows: L3306 localhost:3306
(That is the correct way! localhost:3306 here means how it's called inside remote server, our destination is the 'localhost:3306' there))))

1. Have a possible common root folder (root root folder) for both Frontend and Backend repos. Then you can open both projects to editor with one "Open folder" command. And also the 'find in folder' seems to only work in VS Code if project appears as subfolder?
2. clone Backend repo from GitHub while in that common root folder > git clone repo_link_from_git_hub_com
3. > pwd to make sure where you are! Then cd repo_folder_here
4. > pwd again for folder awareness!
5. run > npm install if in the repo root folder, to automatically install the dependencies from the package.json. (Somebody else has already run the npm init & needed npm install this-and-that-library commands earlier, you just git clone and nmp install)
6. Create .env file to the root folder. Example contents below DB_DATABASE is actually your schema name on the database server. If you use your own installation of mariadb, it could be e.g. "test" or "casedb" or "schema12". Double check that the host and port are 'localhost' and '3306'. (If you use the SSH tunnel). Well, just be aware of all the settings and what are correct for YOUR case.
7. >npm start
8. or even better: npm i -g nodemon and then just nodemon in the backend root folder.
9. test e.g. http://localhost:8777/api/category/ and http://localhost:8777/api/category/ or even the POST services if using PostMan.
10. ((now ready to setup and run Frontend project))

(If problems, You can of course also first run without env variables, use hard-coded values, though do not then accidentally enter the values in git.

And also with local MariaDB installation, localhost, port 3306, even without the SSH tunnel

And then, when all tests ok with basic version, start to add compicating things)

****** Sample .env file (dotenv library will use it). REMOVE THE COMMENTS!!! *****

BE_API_URL_PREFIX=/api
BE_SERVER_PORT=8777
DB_DRIVER_MODULE=mysql
DB_HOST=localhost           local database OR local tunneling? both localhost
DB_PORT=3306                did your tunnel start from 3306?
DB_USER=XXXXXXXX            what did you set or you were given?
DB_PASSWORD=XXXXXXXXX       what did you set or you were given?
DB_DATABASE=casedb               or e.g.   schema12
DB_DEBUG=true                        REMOVE THE COMMENTS ABOVE!
DB_MULTIPLE_STATEMENTS=true
DB_CONNECTION_POOL_MIN=1
DB_CONNECTION_POOL_MAX=7

***** END of .env file *****

PostMan link for the common PostMan tests: (Not yet created, but just example how could share them as links!)

https://www.getpostman.com/collections/not_yet_there (Nowadays free version allows sharing between three developers only. Thus NOT shared as link)

SSH Tunneling to mariadb at remote server

Windows system:

Option 1 Unix system command line: (Or e.g. in the Git Bash console on Windows, though might need to omit -f in Windows or Mac sometimes?)

ssh -f linux_user_here@ip_address_of_remote_comp_here -L 3306:localhost:3306 -N

// Here the first 3306 means local pc, second 3306 means remote computer

Option 2 Tunnel with Putty:

• Host Name:
• Saved Sessions: MariaDB server SSH Tunnel
  
• Do no change the other defaults (Protocol: SSH, Port: 22)
  
• After saving, go to Connection / SSH / Tunnels
  
• Write to Source Port: 3306 This is our own computer port (marked often with big L) !!!
  
• Write to Destination: localhost:3306 (This means where to go in remote computer)
  
• Click on “add”, s
• Go back to the first view, select the session “MariaDB server SSH Tunnel” and save it again!
  
• Now you can click open on the session “MariaDB server SSH Tunnel” to use it
  

The executed ssh command sets up an ssh tunnel through the cli. After execution allow the fingerprint exchange with "yes" and type in your student accounts password.
NOTE: DO NOT CLOSE THE TERMINAL OR PUTTY SESSION. Closing the session will close the tunnel.

Command-line commands available

• npm start or nodemon - will start the server (point your browser to http://localhost:8777 to see a welcome message from the backend or to http://localhost:8777/api/category/ to see a list of entries from Category table)

Usefull links

• Express.js docs in case its needed express.js
• All knex.js commands knex.js NOTE: ctrl+f is your friend
• Winston logger - Winston at npmjs
• Express-validator, middleware express-validator
  • brings validator to Express app
• All ES6 features can be found on this cheatsheet ES6
• Git cheatsheet git