-
Notifications
You must be signed in to change notification settings - Fork 355
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- clean up and organize readme - split development guide - add direct esm loading from browser link Ref #2616
- Loading branch information
netil
authored and
netil
committed
Oct 26, 2022
1 parent
4621f26
commit f3f8592
Showing
5 changed files
with
33,660 additions
and
24,872 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
## How to start developing billboard.js? | ||
|
||
For anyone interested in developing billboard.js, follow the instructions below. | ||
> Required Node.js version: `10.10.0+` | ||
### Development Environment | ||
|
||
#### 1. Clone the repository | ||
|
||
Clone the billboard.js repository and install the dependency modules. | ||
|
||
```bash | ||
# Create a folder and move. | ||
$ mkdir billboard.js && cd billboard.js | ||
|
||
# Clone the repository. | ||
$ git clone https://github.com/naver/billboard.js.git | ||
``` | ||
|
||
#### 2. Install dependencies | ||
`npm` and `Yarn` are supported. | ||
|
||
``` | ||
# Install the dependency modules. | ||
$ npm install | ||
# or | ||
$ yarn | ||
``` | ||
|
||
#### 3. Build | ||
|
||
Use npm script to build billboard.js | ||
|
||
```bash | ||
# Run webpack-dev-server for development | ||
$ npm start | ||
|
||
# Build | ||
$ npm run build | ||
|
||
# Generate jsdoc | ||
$ npm run jsdoc | ||
``` | ||
|
||
Two folders will be created after the build is completed. | ||
|
||
- **dist** folder: Includes the **billboard.js** and **billboard.min.js** files. | ||
- **doc** folder: Includes API documentation. The home page for the documentation is **doc/index.html**. | ||
|
||
### Linting | ||
|
||
To maintain the same code style and quality, we adopted [ESLint](https://eslint.org/). The [rules](https://github.com/naver/eslint-config-naver/tree/master/rules) are based on the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) with some modifications. | ||
Setup your editor for check or run the below command for linting. | ||
|
||
```bash | ||
$ npm run lint | ||
``` | ||
|
||
### Test | ||
|
||
Once you created a branch and finished the development, you must perform a test with `npm test` command before the push to a remote repository. | ||
|
||
```bash | ||
$ npm test | ||
``` | ||
Running the `npm test` command will start [Mocha](https://mochajs.org/) tests via [Karma-runner](https://karma-runner.github.io/). | ||
|
||
## Bug Report | ||
|
||
If you find a bug, please report to us by posting [issues](https://github.com/naver/billboard.js/issues) on GitHub. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,6 +11,7 @@ node_modules | |
dist | ||
dist-ssr | ||
*.local | ||
.* | ||
|
||
test/coverage | ||
test/__snapshots__ | ||
|
Oops, something went wrong.