Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/idea2app/rest-node-ts

RESTful API service scaffold based on Node.js & TypeScript, which is a lite Back-end framework compared with Nest.js. And it can be deployed to Docker-compose-based clouds much more easier with GitHub actions.
https://github.com/idea2app/rest-node-ts

api docker koa mvc nodejs restful scaffold service swagger typescript

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/idea2app/rest-node-ts
Owner: idea2app
Created: 2022-04-01T10:51:08.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2024-09-14T16:05:19.000Z (5 months ago)
Last Synced: 2024-09-16T01:56:16.496Z (5 months ago)
Topics: api, docker, koa, mvc, nodejs, restful, scaffold, service, swagger, typescript
Language: TypeScript
Homepage:
Size: 444 KB
Stars: 6
Watchers: 3
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: ReadMe.md

Awesome Lists containing this project

README

        # REST-Node-ts

[REST][1]ful API service scaffold based on [Node.js][2] & [TypeScript][3]

[![Deploy to Production environment](https://github.com/idea2app/REST-Node-ts/actions/workflows/deploy-production.yml/badge.svg)][4]

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)][5]

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)][6]

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][7]

## Technology stack

1. HTTP server: [Koa][8]

2. Controller framework: [Routing Controllers][9]

3. Model framework: [Class Transformer][10] & [Class Validator][11]

4. ORM framework: [TypeORM][12]

5. API document: [Swagger][13]

6. Mock API: [OpenAPI backend][14]

7. Test framework: [Jest][15]

## Major features

1. [API entry & Health checking](source/controller/Base.ts)

2. [User & Session](source/controller/User.ts)

3. [OAuth sign in](source/controller/OAuth.ts)

    - recommend to use with [Next SSR middleware][16]

4. [Activity logging](source/controller/ActivityLog.ts)

## Best practice

1.  Install GitHub apps in your organization or account:

    1.  [Probot settings][17]: set up Issue labels & Pull Request rules

    2.  [PR badge][18]: set up Online [VS Code][19] editor entries in Pull Request description

2.  Click the **[Use this template][20] button** on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above

3.  Click the **[Open in GitHub codespaces][8] button** on the top of ReadMe file, then an **online VS Code development environment** will be started immediately

4.  Recommend to add a [Notification step in GitHub actions][21] for your Team IM app

5.  Remind the PMs & users of your product to submit **Feature/Enhancement** requests or **Bug** reports with [Issue forms][22] instead of IM messages or Mobile Phone calls

6.  Collect all these issues into [Project kanbans][23], then create **Pull requests** & add `closes #issue_number` into its description for automation

## API Usage

-   Entry: http://localhost:8080/

-   Document: http://localhost:8080/docs/

-   Schema: http://localhost:8080/docs/spec/

-   Type: https://github.com/idea2app/REST-Node-ts/pkgs/npm/rest-node-ts

## Environment variables

|      Name      |            Usage             |

| :------------: | :--------------------------: |

|  `APP_SECRET`  |   encrypt Password & Token   |

| `DATABASE_URL` | PostgreSQL connection string |

## Development

### Installation

```shell

npm i pnpm -g

pnpm i

```

### Start Development environment

```shell

pnpm dev

```

or just press F5 key in [VS Code][19].

### Migration

```shell

pnpm upgrade:dev

```

## Deployment

### Start Production environment

```shell

npm start

```

### Migration

```shell

pnpm upgrade:pro

```

### Docker

```shell

pnpm pack-image

pnpm container

```

## Releasing

### Deploy Application

```shell

git checkout master

git tag v1.0.0  # this version tag comes from ./package.json

git push origin master --tags

```

### Publish Type Package

```shell

git checkout master

git tag type-v1.0.0  # this version tag comes from ./type/package.json

git push origin master --tags

```

[1]: https://en.wikipedia.org/wiki/Representational_state_transfer

[2]: https://nodejs.org/

[3]: https://www.typescriptlang.org/

[4]: https://github.com/idea2app/REST-Node-ts/actions/workflows/deploy-production.yml

[5]: https://render.com/deploy

[6]: https://codespaces.new/idea2app/REST-Node-ts

[7]: https://gitpod.io/?autostart=true#https://github.com/idea2app/REST-Node-ts

[8]: https://koajs.com/

[9]: https://github.com/typestack/routing-controllers

[10]: https://github.com/typestack/class-transformer

[11]: https://github.com/typestack/class-validator

[12]: https://typeorm.io/

[13]: https://swagger.io/

[14]: https://github.com/anttiviljami/openapi-backend

[15]: https://jestjs.io/

[16]: https://github.com/idea2app/Next-SSR-middleware

[17]: https://github.com/apps/settings

[18]: https://pullrequestbadge.com/

[19]: https://code.visualstudio.com/

[20]: https://github.com/new?template_name=REST-Node-ts&template_owner=idea2app

[21]: https://github.com/kaiyuanshe/kaiyuanshe.github.io/blob/bb4675a56bf1d6b207231313da5ed0af7cf0ebd6/.github/workflows/pull-request.yml#L32-L56

[22]: https://github.com/idea2app/REST-Node-ts/issues/new/choose

[23]: https://github.com/idea2app/REST-Node-ts/projects