node js sequelize postgresql example github

On your local box, clone the project and navigate to your project directory. gitignore for Node apps, a LICENSE file, and a README.md file. The list isn’t meant to be perfect you’ll need to refine certain steps, fill in missing steps, and take care of problems along the way. Here is a very rough list of steps we take to build up our web service. We’re going to build a webservice on top of a relational database for a hypothetical non-profit community service center. Set up Postgres so that the Postgres server runs on port 5432 (the default). Make sure you have installed Node (at least 6.10) and Postgres. The notes here are heavily influenced by an awesome tutorial by James Muturi. Let’s build a Webapp with Node, Express, Sequelize, and Postgres. If you have any questions, drop a comment below.Sequelize is an ORM for Node. This is a basic example of building a CRUD rest API using Node.js, Express, Sequelize, Postres, Docker, and Docker Compose.Īll the code is available in the GitHub repository: įor a video version: If you prefer a video version: We can also check the values using TablePlus Make a DELETE reuqest to localhost:3000/users/3 Make a PUT reqeust to localhost:3000/users/2 with a different body Let's update an existing user, for example the same user 2 Make a GET request to localhost:3000/users/2 Let's get a single user, for example the user 2 We should have an empty array as a response Make a GET request to localhost:3000/users This should be the output on the terminal Second, let's build our Docker iamge: docker compose buildįinally, let's start the service: docker compose up node_app (password is 12345 if you left the values as they are) If we see 'database system is ready to accept connections' we are good to go!Ĭlick on the + to create a new connectionĬopy the values from the docker-compose.yml file. You should get an output similar to this one: To check the logs, we can type: docker compose logs CRUD Controllers //get all users exports.getUsers = ( req, res, next) => īuild the Docker image and run the docker containers Run Postgres in a containerįirst, let's run the postgres container: docker compose up -d node_db Populate the controllers/users.js file const User = require( './models/user') This is the file that contains all the functions to execute in order to interact with the database and have the 4 basic functionalities:Ĭreate a file called 'users.js' inside the 'controllers' folder

Populate the models/user.js file: const Sequelize = require( 'sequelize') This file will contain the model, in this case a user with an auto-incremented id, a name and an email. Populate the util/database.js file const Sequelize = require( 'sequelize') Ĭreate a file called 'user.js' inside the 'models' folder. This file will contain the internal configuration to allow the connection between the Node.js application and the running Postgres instance. Database connectionĬreate a file called 'database.js' inside the 'util' folder. You should now have a folder similar to this one: If you have Visual Studio Code, you can type this from the terminal: code. Sequelize is the ORM so we avoid typing SQL queriesĬreate 4 folders mkdir controllers routes util models Pg is a driver for a connection with a Postgres db Install the dependencies npm i express pg sequelize We will create a docker compose file to run both the services We will have a Postgres istance, we will test it with Tableplus We will Dockerize the Node.js application We will create a Node.js application using: We will create 5 endpoints for basic CRUD operations: Here is a schema of the architecture of the application we are going to create: Let's create a CRUD rest API in JavaScript, using:

Node js sequelize postgresql example github