Skip to content

Griffin-Web-Studio/SpecWell

Repository files navigation

Welcome to GWS Spec-Checker Tool 👋

License: Modified GNU General Public License (GPL) version 3

A simple Tool to overlay the Spec Design over the live preview website.

🏠 Homepage | ✨ Demo

Usage

Install

bun install

Development

bun run dev

Production

bun run build

Tests

bun test

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

  • Configure the top-level parserOptions property like this:
export default {
  // other rules...
  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
    project: ['./tsconfig.json', './tsconfig.node.json'],
    tsconfigRootDir: __dirname,
  },
}
  • Replace plugin:@typescript-eslint/recommended to plugin:@typescript-eslint/recommended-type-checked or plugin:@typescript-eslint/strict-type-checked
  • Optionally add plugin:@typescript-eslint/stylistic-type-checked
  • Install eslint-plugin-react and add plugin:react/recommended & plugin:react/jsx-runtime to the extends list

Author

👤 Rihards Simanovics

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Griffin Web Studio Limited.
Copyright © 2022 Rihards Simanovics.
This project is Modified GNU General Public License (GPL) version 3 licensed.