Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrewjbateman/postgresql-rest-api
:clipboard: PostgreSQL database used with nodejs and express to create a REST API
https://github.com/andrewjbateman/postgresql-rest-api
crud databases express-middleware nodejs nodemon pgsql postgresql postgresql-database typescript
Last synced: about 1 month ago
JSON representation
:clipboard: PostgreSQL database used with nodejs and express to create a REST API
- Host: GitHub
- URL: https://github.com/andrewjbateman/postgresql-rest-api
- Owner: AndrewJBateman
- Created: 2020-04-17T10:05:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T12:31:46.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T09:41:31.778Z (about 1 month ago)
- Topics: crud, databases, express-middleware, nodejs, nodemon, pgsql, postgresql, postgresql-database, typescript
- Language: TypeScript
- Homepage:
- Size: 514 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :zap: PostgreSQL Rest API
* App using nodejs with express middleware to connect to a PostgreSQL database and make Create, Read, Update & Delete (CRUD) operations of user data
* **Note:** to open web links in a new window use: _ctrl+click on link_
## :page_facing_up: Table of contents
* [General info](#general-info)
* [Screenshots](#screenshots)
* [Technologies](#technologies)
* [Setup](#setup)
* [Code Examples](#code-examples)
* [Features](#features)
* [Status](#status)
* [Inspiration](#inspiration)
* [Licence](#licence)
* [Contact](#contact)
## :books: General info
* PostgreSQL needs to be installed and running - I started it from my Windows 10 PostgreSQL 12 dropdown option 'SQL shell (psql)'
* PostgreSQL shell commands: `\l` list all databases. `\c database1` connect to database1. `\dt` inspect tables. `\d users` see detail of table with name users. `\q` to quit.
* Src (source) folder contains raw code in typescript. Dist (distribution) folder will contain minified/concatenated javascript code for production
## :camera: Screenshots
## :signal_strength: Technologies
* [tsc --watch command](https://www.typescriptlang.org/docs/handbook/compiler-options.html) used to run local compiler in watch mode
* [PostgreSQL v12](https://www.postgresql.org/) database
* [PostgreSQL Installer for Windows](https://www.postgresqltutorial.com/install-postgresql/)
* [Express.js middleware v4](https://expressjs.com/)
* [Postman](https://www.postman.com/) to perform CRUD operations on backend database
## :floppy_disk: Setup
* Create PostgreSQL database and add access credentials to your own `src/routes/config.ts` file (see `config.example.ts`)
* Add a `/dist` folder at same level as `/src` folder
* Run `npm install` to install dependencies
* Run `npm run dev` to compile app and connect to server `localhost: 3000`
* Run `npm run build` to compile app
## :computer: Code Examples
* code to fetch a user from the Postgres database using id
```typescript
export const getUserById = async (
req: Request,
res: Response
): Promise => {
const id = parseInt(req.params.id);
const response: QueryResult = await pool.query(
"SELECT * FROM users WHERE id = $1",
[id]
);
return res.json(response.rows);
};
```
## :cool: Features
* PostgreSQL access credentials hidden from GitHub in `config` file
* Postman used to perform CRUD operations on PostgreSQL database
## :clipboard: Status & To-do list
* Status: Fully working basic CRUD app
* To-do: nothing
## :clap: Inspiration
* [Fazt Code: Youtube tutorial in Spanish: Nodejs, PostgreSQL & Typescript, REST API CRUD](https://www.youtube.com/watch?v=z4BNZfZ1Wq8)
## :file_folder: License
* N/A
## :envelope: Contact
* Repo created by [ABateman](https://github.com/AndrewJBateman), email: [email protected]