https://github.com/joshuatoth/node-express-jest-psql-typescript-template

A template api using Node, Express, PSQL, Typescript and Jest for testing.
https://github.com/joshuatoth/node-express-jest-psql-typescript-template

api docker express jest node psql template typescript

Last synced: about 1 month ago
JSON representation

A template api using Node, Express, PSQL, Typescript and Jest for testing.

• Host: GitHub
• URL: https://github.com/joshuatoth/node-express-jest-psql-typescript-template
• Owner: JoshuaToth
• License: mit
• Created: 2020-03-09T10:59:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T01:35:09.000Z (almost 2 years ago)
• Last Synced: 2024-09-28T18:21:29.144Z (about 2 months ago)
• Topics: api, docker, express, jest, node, psql, template, typescript
• Language: TypeScript
• Size: 966 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Typescript, Nodejs, Express, Postgres server.

A basic API you can run locally with minimal setup.

Includes Unit tests and E2E tests to ensure the DB can be hit.

## Setup

The Postgres CLI will need to be used and docker needs to be running on your machine.

```

brew install postgresql

npm i

```

## running development

```

cp ./environment/local_example.env .env

docker-compose up -d

npm run dev

```

or

`./scripts/run-local.sh`

or if you want to run it all in docker

`./scripts/run-local-docker.sh`

## running tests (unit)

`npm run test:unit`

## running tests (e2e)

Ensure docker is running

`npm run test:e2e`