https://github.com/yo-mah-ya/backendapp-with-openapiv3-postgresql

BackendApp with OpenAPIV3 PostgreSQL implemented with TypeScript
https://github.com/yo-mah-ya/backendapp-with-openapiv3-postgresql

express openapi3 postgres typescript

Last synced: 23 days ago
JSON representation

BackendApp with OpenAPIV3 PostgreSQL implemented with TypeScript

• Host: GitHub
• URL: https://github.com/yo-mah-ya/backendapp-with-openapiv3-postgresql
• Owner: Yo-mah-Ya
• Created: 2021-12-12T13:59:56.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-17T04:49:23.000Z (about 1 year ago)
• Last Synced: 2024-11-20T19:44:30.755Z (3 months ago)
• Topics: express, openapi3, postgres, typescript
• Language: TypeScript
• Homepage:
• Size: 211 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Introductions

install packages and compile all workspace packages

```sh

yarn install

```

The common package is linked as a symbolic link

check it out

```

cd ./node_modules/@backend

ln -s ../../packages/common .

```

# local development

## common

create tables and insert sample data

```

service postgresql start

./resources/common/ddl.sh

```

## api

### build and start or do tests

```

yarn workspace @backend/api build

yarn workspace @backend/api start

yarn workspace @backend/api test

```

### with environment values

```

./resources/api/local_dev.sh compile

./resources/api/local_dev.sh start

./resources/api/local_dev.sh test

```

### add libraries to the entire project

```

yarn add `some package` -W

or

yarn add --dev `some package` -W

```

### OpenAPI docs

open shown below on the Web browser

```

localhost:3000/api-docs/#

```

# Directories

tree -I "node_modules|build"