https://github.com/jangbl/objection-js-tutorial
Objection.js tutorial with Postgres and express that demonstrates migrations, seed data and eager loading
https://github.com/jangbl/objection-js-tutorial
Last synced: 3 months ago
JSON representation
Objection.js tutorial with Postgres and express that demonstrates migrations, seed data and eager loading
- Host: GitHub
- URL: https://github.com/jangbl/objection-js-tutorial
- Owner: jangbl
- Created: 2021-01-30T14:13:25.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-05-13T11:01:49.000Z (over 2 years ago)
- Last Synced: 2025-06-01T07:06:20.263Z (7 months ago)
- Language: JavaScript
- Size: 1.56 MB
- Stars: 20
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Objection.js Tutorial with Postgres and Express
This tutorial demonstrates how to connect to a [Postgres](https://www.postgresql.org) database with [Objection.js](https://vincit.github.io/objection.js/).
It also demonstrates how to create the database schema and how to create seed data with the [knex.js](http://knexjs.org) migration tool.
Please help this repo with a ⭐️ if you find it useful! 😁
This repository is contains the code for the [Objection.js tutorial on Youtube](https://www.youtube.com/watch?v=zbIl2kuP7tE)
[](https://www.youtube.com/watch?v=zbIl2kuP7tE)
Please also check out my website at [jangoebel.com](https://jangoebel.com)
For updates, please follow [@_jgoebel](https://twitter.com/_jgoebel) on Twitter.
# How to run this application
This application needs a local [Postgres](https://www.postgresql.org) instance.
## Installing Postgres
On macOS you can install [Postgres](https://www.postgresql.org) with [Homebrew](https://brew.sh/).
```
brew install postgresql
```
and start it with
```
brew services start postgres
```
You can stop [Postgres](https://www.postgresql.org) with:
```
brew services stop postgres
```
For other operating systems, please check the [Postgres website](https://www.postgresql.org/download/).
### Database setup
Make sure to update the configuration app with your database credentials in the `../db/knexfile.js` file.
There you need to specify the `user`, `password` (per default no `password` required) and the `database` you want to connect to.
The default database we try to connect to is called `objection_tutorial`. Please make sure it exists in your local [Postgres](https://www.postgresql.org) instance. You can either use a UI like [PgAdmin](https://www.pgadmin.org) to create the database or you can do so with `psql`
```
psql -h localhost -U postgres
```
When installing locally, [Postgres](https://www.postgresql.org) creates a database user with your operation system's username.
You can run
```
whoami
```
on any `Unix-like` operating system to find out your user
Then you can create a new database with:
```
create database objection_tutorial;
```
## Running the application
Once you have installed [Postgres](https://www.postgresql.org) and updated the credentials in the `./db/knexfile.js`, you can
```
npm run dev
```
This will:
1. execute all existing database migrations located in `./db/migrations`
2. execute all seed files located in `./db/seed` so you have some initial data
3. start your server on port `8080` with `nodemon` to provide hot reload functionality
# Additional Scripts
- `npm run down`: undo last migration. Since we only have one migration at the moment this is equivalent to deleting all tables
- `npm run migrate`: executes all migrations in `./db/migrations`
- `npm run make-seed`: create a new seed file