0.0.12 ā€¢ Published 1 year ago

create-se-app v0.0.12

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

create-se-app

bin script to create a productive scaffold for a web client project

yarn create se-app
yarn create se-app <project name>

npm create se-app
npm create se-app <project name>
npx create-se-app
npx create-se-app <project name>

template

current template is based on vite + React + TypeScript, and provides various setups for a productive development and cooperation šŸ§‘ā€šŸ’»šŸ‘¬

āœ”ļø default .prettierrc and .eslintrc including module import/order rules

āœ”ļø husky pre-commit hook to automatically lint codes before commit

āœ”ļø @ absolute path configuration for ./src directory

āœ”ļø @types directory as tsconfig typeRoots

āœ”ļø other client-necessary modules such as reset.css and react-router-dom

āœ”ļø default github Issue, PR templates and issue-label-manager-action

template
ā”œā”€ā”€ .github
ā”œā”€ā”€ .husky
ā”œā”€ā”€ .eslintrc
ā”œā”€ā”€ .prettierrc
ā”‚
ā”œā”€ā”€ index.html
ā”œā”€ā”€ package.json
ā”œā”€ā”€ public
ā”œā”€ā”€ src
ā”‚   ā”œā”€ā”€ App.tsx
ā”‚   ā”œā”€ā”€ main.tsx
ā”‚   ā”œā”€ā”€ @types
ā”‚   ā”œā”€ā”€ apis
ā”‚   ā”œā”€ā”€ assets
ā”‚   ā”œā”€ā”€ components
ā”‚   ā”œā”€ā”€ constants
ā”‚   ā”œā”€ā”€ hooks
ā”‚   ā”œā”€ā”€ pages
ā”‚   ā”œā”€ā”€ routes
ā”‚   ā”œā”€ā”€ styles
ā”‚   ā””ā”€ā”€ utils
ā”œā”€ā”€ tsconfig.json
ā”œā”€ā”€ tsconfig.node.json
ā”œā”€ā”€ tsconfig.path.json
ā””ā”€ā”€ vite.config.ts

āœØ You can create your own create- package by:

  1. Fork / clone this repository

  2. Replace the template directory with your project boilerplate

  3. Rewrite package.json and npm publish it

Additional settings (manual and optional)

  1. Modify .<lint>rc, ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, and labels.json according to your team's preference.

  2. Both tsconfig.path.json and vite.config.ts need to be configured when adding absolute path aliases.

  3. To utilize the issue-label-manager-action which automatically creates issue labels defined in .github/labels.json:

    • Better remove .github/workflows/label-manager.yml if you don't need it.

    • Repository should have your github access token as PERSONAL_TOKEN env variable.

      - uses: lannonbr/issue-label-manager-action@4.0.0
          env:
            GITHUB_TOKEN: ${{ secrets.PERSONAL_TOKEN }}

      npm.io

      You can generate and manage these tokens at Developer settings.

      npm.io

    • And a dummy issue should be created to trigger the label creation

      on: issues
0.0.12

1 year ago

0.0.11

1 year ago

0.0.1

1 year ago

0.0.0

1 year ago