Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adam-robson/node-express-postgres-server

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/adam-robson/node-express-postgres-server
Owner: Adam-Robson
Created: 2023-04-01T11:15:00.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-10-23T09:36:14.000Z (2 months ago)
Last Synced: 2024-10-25T01:46:29.120Z (2 months ago)
Language: JavaScript
Size: 316 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # node-express-postgres-server

[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://adamrobson.vercel.app/)

[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/adamrayrobson)

This is a node application built with [Express](https://expressjs.com/) and [Postgres](https://www.postgresql.org/).

## Table of Contents

- [node-express-postgres-server](#node-express-postgres-server)

  - [Table of Contents](#table-of-contents)

  - [General Information](#general-information)

  - [Features](#features)

  - [Run Locally](#run-locally)

  - [Routes](#routes)

  - [Technologies Used](#technologies-used)

## General Information

This project was originally built while with Alchemy in Portland, Oregon in 2022.

I have since updated it to include JavaScript es-module syntax with designs on moving it to TypeScript soon.

## Features

The application uses Express to create a server and Postgres to create a database.

It includes the functionality to Create Read Update and Delete books from the database and includes authorization and authentication for tracking users.

## Run Locally

| Command                 |        Description                             |

| `npm start`             | Starts the app - should only be used in        |

|                         | production as changes will not get reloaded    |

| `npm run start:watch`   | Runs the app using `nodemon` which watches for |

|                         | changes and reloads the app                    |

| `npm test`              | Runs the tests once                            |

| `npm run test:watch`    | Continually watches and runs the tests when    |

|                         | files are updated                              |

| `npm run setup-db`      | Sets up the database locally                   |

## Routes

- `/books` `GET` Gets a list of books

- `/books/:id` `GET` Gets a particular book

- `/authors` `GET` Gets a list of authors

- `/authors/:id` `DELETE` Deletes a particular author

- `/users/sessions` `POST` Creates a user

## Technologies Used

- JavaScript

- Express

- Babel

- Node

- Postgres

- Postman

- Jest

- Nodemon

- ESLint

- Prettier

- GitHub Actions