mirror of
https://github.com/liriliri/eruda.git
synced 2026-04-01 10:18:35 +08:00
33 lines
707 B
Markdown
33 lines
707 B
Markdown
# Contributing Guide
|
|
|
|
## Development Setup
|
|
|
|
[Node.js](https://nodejs.org/en/) is needed for the development of eruda.
|
|
|
|
After cloning the repo, run:
|
|
|
|
```bash
|
|
# install npm dependencies.
|
|
npm install
|
|
# copy jasmine lib from node_modules to test folder.
|
|
npm run cpTestLib
|
|
```
|
|
|
|
## Commonly used NPM scripts
|
|
|
|
```bash
|
|
# watch and auto re-build, webpack-dev-server is required.
|
|
npm run dev
|
|
# build eruda.js and eruda.min.js
|
|
npm run build
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
- **dev**: development related files.
|
|
- **doc**: documents.
|
|
- **eustia**: eustia extended utilties.
|
|
- **script**: webpack configuration, and some other useful scripts.
|
|
- **src**: source code, written in es2015.
|
|
- **test**: contain pages for testing.
|