Skip to content

Latest commit

 

History

History
52 lines (45 loc) · 2.83 KB

README.md

File metadata and controls

52 lines (45 loc) · 2.83 KB

expressknex

A project to demonstrate how to connect html to express and use knex for database migration

Clone

Clone the project git clone https://github.com/LarryKiniu/expressknex.git on your terminal/cmd

Install dependencies

Install the global dependency (knex) by running the command npm install knex -g on your terminal/cmd
Install the project dependencies by running npm install or in case you are using yarn yarn on your terminal/cmd

Database

Create the database expess-knex in mysql.
Recreate the database with the most current changes (migrations) by running npm run migrate or yarn migrate To create a new table or update exisiting column just run knex migrate:make <your_table_name>
Follow the Knex migrations tutroial to learn how to add table columns
To use Knex - you need a knexfile.jsin the root of your project

Run the app

To run the app, run node index.js on your terminal/cmd

Project structure

The project folder structure is as follows:

  • migrations
    |_________database migrations files created by running knex migrate:make <your_table_name>
  • node_modules
    |_________dependencies installed by running npm install (it's ignored by git since it is in .ignore file)
  • public
    |_________all your static files (html, css. javascript, images)
  • .gitignore
    |_________file to indicate which files and folder git should ignore - you generally want to ignore your dependencies as you can always install them using npm install
  • index.js
    |_________your app entrance file
  • knexfile.js
    |_________knex configuration file where you indicate your database (mysql etc), connection details (host, user, password, database)
  • package.json
    |________file to configure your app (name, version, description, dependencies)
  • README.md
    |________file to describe what the app is for and how to install and run the app

Learn

Follow the comments on the code to know how to connect express to frontend html and javascript

References