Logo

Short description

Table of contents

• Table of contents
• Quick start
• Status
• What's included
• Bugs and feature requests
• naming conventions rules
• Contributing
• Creators
• Thanks
• Copyright and license

Quick start

• install module

$ npm i

• create .env file

touch src/pages/.env

• copy variables to .env file.

VITE_MOCKING=false
VITE_API_PATH='./api'

VITE_TITLE=title
VITE_SUBSCRIPTION=description
VITE_URL=https://jameshsu1125.github.io
VITE_FACEBOOK_ID=your-facebook-id

• start project

$ npm run dev

• build static file to /dist

$ npm run build

Status

• Development since January 2023
• use vite for development environment and bundler.
• use React for main javascript library.
• use Typescript for syntax.
• use LessCSS and TailwindCSS for css library.
• use ESLint rules for coding style.
• use Mocks and faker for testing API

What's included

• public folder will copy to /dist
• src folder is reactJs entry point. default file is named as pages/index.tsx

Bugs and feature requests

• Node version must be above v18
• I will not maintain when this project is closed

naming conventions rules

1. general variable - Camel Case

   ex: setState、currentTarget、pinkBackground、innerText

2. react components and class name - Pascal Case.

   ex: RegularButton、NavigationBar

3. global variable or state - Pascal Case.

   ex: Context、LandingState

4. Immutable variable or environment variable - Screaming Snake Case.

   ex: PAGE、VITE_TITLE

5. type - I = interface, T = type.

   ex: IProps、TResult

6. enum options - Pascal Case + "Type".

   ex: ActionType、AlertType、ModalType

7. class name = Snake Case.

   ex: .button-group、.button-label

naming-conventions

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, all HTML and CSS should conform to the Code Guide, maintained by Main author.

Creators

maintainer, developer

• James Hsu

Thanks

Thank customers and some manufacturers for their support.

Copyright and license

Code and documentation copyright 2011-2022 the authors. Code released under the MIT License.