https://github.com/anechas/express-ts-sequelize-template

https://github.com/anechas/express-ts-sequelize-template

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/anechas/express-ts-sequelize-template
• Owner: AnechaS
• License: mit
• Created: 2024-05-11T01:24:28.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-30T16:05:10.000Z (3 months ago)
• Last Synced: 2024-07-31T19:32:06.596Z (3 months ago)
• Language: TypeScript
• Size: 794 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Express.js REST API template with TypeScript and Sequelize

Structure is module pattern.

## Installation

```bash

$ npm install

```

After starting the server, you can visit http://localhost:3000 in your browser

## Building

```bash

$ npm run build

```

## Running

```bash

$ npm start

```

## Development

```bash

$ npm run dev

```

## Testing

```bash

$ npm test

```

## Update version

```bash

$ npm run release

```

## Commit

```bash

$ npm run commit

```

## Using Docker

```bash

$ docker build -t my-app .

$ docker run --name my-app-example --env-file ./.env -p 3000:3000 -d  my-app

```

## Configuration

Create a `.env` file and configure your settings by referring to the `.env.example` file.

## Locally

```bash

$ npm i

$ npm run build && npm start

```