Skip to content

Commit 855e732

Browse files
committed
chore: update contribution guide
1 parent da23b14 commit 855e732

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,31 @@ Or play it right in your browser now:
2626

2727
[![](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/eslint/config-inspector)
2828

29+
## Contributing
30+
31+
We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/config-inspector/issues).
32+
33+
### Development
34+
35+
This project uses the following stack:
36+
37+
- [pnpm](https://pnpm.io/) for package management
38+
- [Nuxt](https://nuxt.com/) & [Vue](https://vuejs.org) for the app
39+
- APIs are served under `server/api` powered by [Nitro](https://nitro.unjs.io/)
40+
- [UnoCSS](https://unocss.dev/) for styling
41+
- With [attributify mode](https://unocss.dev/presets/attributify) enabled
42+
- Use [ESLint](https://eslint.org/) for linting and formatting
43+
44+
To start the development server:
45+
46+
- Install dependencies via `pnpm install` (we highly recommend you to [enable `corepack enable`](https://nodejs.org/api/corepack.html) first)
47+
- Run `pnpm dev` to start the development server at http://localhost:3000
48+
49+
To test the production build:
50+
51+
- Run `pnpm build` to build the app
52+
- Run `pnpm start` to start the production server at http://localhost:7777
53+
2954
## License
3055

3156
[Apache-2.0](./LICENSE) License

0 commit comments

Comments
 (0)