https://github.com/lydanne/deepkit-template

a deepkit template.
https://github.com/lydanne/deepkit-template

Last synced: 6 days ago
JSON representation

a deepkit template.

• Host: GitHub
• URL: https://github.com/lydanne/deepkit-template
• Owner: Lydanne
• Created: 2022-05-02T17:03:39.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-05-04T15:49:29.000Z (over 2 years ago)
• Last Synced: 2024-08-10T07:48:15.221Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 193 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Deepkit Template

a deepkit quick start template, help you quickly build a development environment.

## Feature

- [x] Automatic identification environment.(local,dev,prod,...)

- [x] Support npm and pnpm.

- [x] Minimize permissions for integrating user and role (RBAC).

- [x] Neat directory structure.

- [x] Automatic reload.

- [x] Jest unit test integration.

- [x] Intelligent configuration.

- [ ] E2E auto test.

- [ ] Git commit verify.

- [ ] Client apisdk generation.

- [ ] Integrating eslint and prettier(Look forward to using Rome instead).

- [ ] Automatic version change and generate changelog.

## Bootstrap

### start

```bash

git clone https://github.com/WumaCoder/deepkit-template.git

pnpm i # or npm i

pnpm dev # npm run dev

```

### build

```base

pnpm build

```

visit `http://localhost:3000`.

## Environment

We can access it automatically through `e(key, defaultValue)` method `.env `or `.env.dev` or `.env.local` or `.env.prod` file.

Order:

```

       .env.dev

.env < .env.local

       .env.prod

```

Environment switching:

```

1.`.env` file

NODE_ENV = prod # dev or local

2.system env

export NODE_ENV = prod

```

.env > system env

## About

WumaCoder