KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

node-crudapi-ts

★ 45 Open GitHub ↗

CRUD boilerplate for create Node Restful API's with Express Framework and Sequelize ORM written in Typescript.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Node CrudAPI Boilerplate | TypeScript</h1>
<p align="center"><a href="http://nodejs.org" target="blank">Node</a> boilerplate for create CRUDs and restful API's with <a href="https://expressjs.com/" target="blank">Express Framework</a> and <a href="https://docs.sequelizejs.com" target="blank">Sequelize ORM</a> written in <a href="https://www.typescriptlang.org/" target="blank">Typescript</a>.</p>
<p align="center">
</p>

- [1.  Installing](#1-installing)
  - [Install dependencies](#install-dependencies)
  - [Installing pm2](#installing-pm2)
  - [Environments](#environments)
- [2. Database](#2-database)
  - [Install database driver](#install-database-driver)
  - [Database Config](#database-config)
  - [Migrations and Seeders](#migrations-and-seeders)
  - [Creating Migration](#creating-migration)
  - [Running Migration](#running-migration)
  - [Creating Seed](#creating-seed)
  - [Running Seed](#running-seed)
- [3.  Schedules](#3-schedules)
  - [Installing](#installing)
  - [Configuring](#configuring)
- [4. Running](#4-running)
- [5. Building](#5-building)
  - [DEV](#dev)
  - [PROD](#prod)
- [6. Docs](#6-docs)

## 1.  Installing

#### Install dependencies

```bash
$ npm i
```

#### Installing pm2
```bash
$ npm i -g pm2
```

#### Environments

Copy `.env.example` to `.env` and set environments

## 2. Database
#### Install database driver

- **PostgresSQL**
```bash
$ npm install --save pg pg-hstore
```

- **MySQL**
```bash
$ npm install --save mysql2
```

- **MariaDB**
```bash
$ npm install --save mariadb
```

- **SQLite**
```bash
$ npm install --save sqlite3
```

- **SQL Server**
```bash
$ npm install --save tedious
```

#### Database Config
Setting config database connection on config file:  `config/database.js`
***if you will not use migrations or seeds this config  can be created with ".ts" extension**
[more config details](http://docs.sequelizejs.com/manual/getting-started.html)

#### Migrations and Seeders
- For implements migrations or seeds install sequelize-cli module:

```bash
$ npm i -g sequelize-cli
```

- Create `database/seeders` and/or  `database/migrations` folder
*OBS: You can create seeds or migrations folders individually*

- Create a `.sequeilizerc` and paste follow code:

```
module.exports = {
  "config": "./config/database.js", //database config file reference
  "seeders-path": "./database/seeders", //remove if you don't use seeders
  "migrations-path": "./database/migrations" //remove if you don't use migrations
};
```

#### Creating Migration

```bash
$ sequelize migration:create --name MIGRATION_NAME
```

#### Running Migration

```bash
$ sequelize db:migrate
```

#### Creating Seed

```bash
$ sequelize seed:create --name SEED_NAME
```

#### Running Seed
```bash
$ sequelize db:seed:all
```

## 3.  Schedules
#### Installing
- For implements Schedules install node-schedule module:

```bash
$ npm i node-schedule --save
```

```bash
$ npm i @types/node-schedule --save-dev
```

#### Configuring

- Create `src/jobs` folder and view [example](https://github.com/albinojunior/nodeapi-typescript/blob/master/examples/job.example.ts) of job file.

- Create `src/schedule.ts` file ande paste follow code or copy from [example](https://github.com/albinojunior/nodeapi-typescript/blob/master/examples/schedule.example.ts)

```javascript
/* src/schedule.ts */
import { resolve } from "path";
import { scheduleJob } from "node-schedule";

import * as fs from "fs";
import { Job } from "./common/interfaces/job";

const env = process.env.NODE_ENV || "development";
const prefix = env == "development" ? "" : "build/";

export default class Schedule {
  public jobs: Job[] = [];

public constructor() {
    this.getJobs();
  }

public getJobs = (): void => {
    const path = resolve(`${prefix}src/jobs`);
    let files = fs.readdirSync(path);
    this.jobs = files.map((file): Job => require(`./jobs/${file}`).default);
  };

public startJobs = (): void => {
    this.jobs.map(
      (job: Job): void => {
        if (job.enabled)
          scheduleJob(job.date, async (): Promise<void> => await job.execute());
      }
    );
  };
}

```
- Import `src/schedule.ts` on app and call **startJobs()** method on *App* constructor

##  4. Running

```bash
$ npm run dev
```

## 5. Building

#### DEV

```bash
$ npm run build:dev
```

#### PROD

```bash
$ npm run build
```

## 6. Docs

- [Sequelize](http://docs.sequelizejs.com/)

node-crudapi-ts

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README