{"id":22221250,"url":"https://github.com/victorbadaro/node-api-knex-example","last_synced_at":"2026-04-13T02:05:41.320Z","repository":{"id":104361457,"uuid":"442427899","full_name":"victorbadaro/node-api-knex-example","owner":"victorbadaro","description":"An example NodeJS API that uses the Knex.js SQL Query Builder","archived":false,"fork":false,"pushed_at":"2023-08-22T21:06:30.000Z","size":122,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T07:13:49.825Z","etag":null,"topics":["api","api-rest","backend","knex","node","orm","postgres","sql"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/victorbadaro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-28T10:27:18.000Z","updated_at":"2021-12-29T02:44:14.000Z","dependencies_parsed_at":"2024-12-03T03:03:49.037Z","dependency_job_id":null,"html_url":"https://github.com/victorbadaro/node-api-knex-example","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorbadaro%2Fnode-api-knex-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorbadaro%2Fnode-api-knex-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorbadaro%2Fnode-api-knex-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorbadaro%2Fnode-api-knex-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victorbadaro","download_url":"https://codeload.github.com/victorbadaro/node-api-knex-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245422921,"owners_count":20612725,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-rest","backend","knex","node","orm","postgres","sql"],"created_at":"2024-12-02T23:12:50.321Z","updated_at":"2026-04-13T02:05:41.281Z","avatar_url":"https://github.com/victorbadaro.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-api-knex-example\n\n[![LEIAME.md](https://img.shields.io/badge/-Leia%20em%20Portugu%C3%AAs-brightgreen?style=for-the-badge)](./LEIAME.md)\n\n## Summary\n- [🧾 About](#-about)\n- [🚀 Main technologies](#-main-technologies)\n- [💻 Usage](#-usage)\n- [👌 Requests](#-requests)\n\n## 🧾 About\nThis project was made to be a simple example of a back-end application using the Knex Query builder\n\n## 🚀 Main technologies\n- [Node.js](https://nodejs.org/)\n- [Express](https://expressjs.com/)\n- [PostgreSQL](https://www.postgresql.org/)\n- [Babel](https://babeljs.io/)\n- [Knex](https://knexjs.org/)\n- [Nodemon](https://nodemon.io/)\n\n_(You can see all the dependencies in the [package.json](./package.json) file)_\n\n## 💻 Usage\nAs you can see on [🚀 Main technologies](#-main-technologies) topic, this application depends on a postgreSQL database, so you must have it installed.\nFirst things first:\n\n1. 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)):\n   ```bash\n   $ git clone https://github.com/victorbadaro/node-api-knex-example.git\n   ```\n\n2. Access its directory:\n   ```bash\n   $ cd node-api-knex-example\n   ```\n\n3. Install its dependencies:\n   ```bash\n   $ yarn\n   # 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\n   ```\n\n4. Access your PostgreSQL server and create the database (you can use any name):\n   ```sql\n   CREATE DATABASE node_api_knex_db;\n   ```\n\n5. 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:\u003cbr /\u003e\n   For example:\u003cbr /\u003e\n   ![image](https://github.com/victorbadaro/node-api-knex-example/assets/9096344/044c580b-a747-4dd8-a012-8bfd41537903)\n\n\n6. Run all the migrations to create the database relations:\n   ```bash\n   $ yarn knex migrate:latest\n   ```\n\n7. Start the server by running the `dev` script:\n   ```bash\n   $ yarn dev\n   ```\n\n## 👌 Requests\nNow 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!\u003cbr /\u003e\nHere are the requests you can make:\n\n- GET /users\n- POST /users\n  ```json\n  {\n    \"name\": \"\",\n    \"email\": \"\"\n  }\n  ```\n- GET /users/:id\n- PUT /users/:id\n  ```json\n  {\n    \"name\": \"\",\n    \"email\": \"\"\n  }\n  ```\n- DELETE /users/:id\n\n- GET /products\n- POST /products\n  ```json\n  {\n    \"description\": \"\",\n    \"user_id\": \n  }\n  ```\n- GET /products/:id\n- PUT /products/:id\n  ```json\n  {\n    \"description\": \"\" \n  }\n  ```\n- DELETE /products/:id\n\n---\n\n\u003cp align=\"center\"\u003eThis project was created and developed with ❤ by \u003ca href=\"https://github.com/victorbadaro\"\u003eVictor Badaró\u003c/a\u003e\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictorbadaro%2Fnode-api-knex-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictorbadaro%2Fnode-api-knex-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictorbadaro%2Fnode-api-knex-example/lists"}