https://github.com/victorbadaro/node-api-knex-example
An example NodeJS API that uses the Knex.js SQL Query Builder
https://github.com/victorbadaro/node-api-knex-example
api api-rest backend knex node orm postgres sql
Last synced: 2 months ago
JSON representation
An example NodeJS API that uses the Knex.js SQL Query Builder
- Host: GitHub
- URL: https://github.com/victorbadaro/node-api-knex-example
- Owner: victorbadaro
- Created: 2021-12-28T10:27:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T21:06:30.000Z (almost 3 years ago)
- Last Synced: 2025-01-30T07:13:49.825Z (over 1 year ago)
- Topics: api, api-rest, backend, knex, node, orm, postgres, sql
- Language: JavaScript
- Homepage:
- Size: 119 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-api-knex-example
[](./LEIAME.md)
## Summary
- [🧾 About](#-about)
- [🚀 Main technologies](#-main-technologies)
- [💻 Usage](#-usage)
- [👌 Requests](#-requests)
## 🧾 About
This project was made to be a simple example of a back-end application using the Knex Query builder
## 🚀 Main technologies
- [Node.js](https://nodejs.org/)
- [Express](https://expressjs.com/)
- [PostgreSQL](https://www.postgresql.org/)
- [Babel](https://babeljs.io/)
- [Knex](https://knexjs.org/)
- [Nodemon](https://nodemon.io/)
_(You can see all the dependencies in the [package.json](./package.json) file)_
## 💻 Usage
As you can see on [🚀 Main technologies](#-main-technologies) topic, this application depends on a postgreSQL database, so you must have it installed.
First things first:
1. Clone the project (you'll need a [personal access token](https://docs.github.com/pt/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls)):
```bash
$ git clone https://github.com/victorbadaro/node-api-knex-example.git
```
2. Access its directory:
```bash
$ cd node-api-knex-example
```
3. Install its dependencies:
```bash
$ yarn
# feel free to use another package manager, but you might want use yarn once there's already a yarn.lock file in the root directory
```
4. Access your PostgreSQL server and create the database (you can use any name):
```sql
CREATE DATABASE node_api_knex_db;
```
5. Create a `.env` file in the root directory with the same content that is in the [.env.example](./.env.example) file and fill the variables with your own data:
For example:
6. Run all the migrations to create the database relations:
```bash
$ yarn knex migrate:latest
```
7. Start the server by running the `dev` script:
```bash
$ yarn dev
```
## 👌 Requests
Now the server is ready to receive your requests! There's a [request collection](./request_collection.json) in the root directory so you can use (use [insomnia](https://insomnia.rest/) to import the collection). Remember to inform the server port in the `baseUrl` environment variable!
Here are the requests you can make:
- GET /users
- POST /users
```json
{
"name": "",
"email": ""
}
```
- GET /users/:id
- PUT /users/:id
```json
{
"name": "",
"email": ""
}
```
- DELETE /users/:id
- GET /products
- POST /products
```json
{
"description": "",
"user_id":
}
```
- GET /products/:id
- PUT /products/:id
```json
{
"description": ""
}
```
- DELETE /products/:id
---
This project was created and developed with ❤ by Victor Badaró