2017-11-18 17:04:14 -08:00
|
|
|
# Contribution Guide
|
|
|
|
|
|
|
|
|
|
Contributions are welcome and are greatly appreciated!
|
|
|
|
|
|
|
|
|
|
## Before you begin
|
|
|
|
|
|
|
|
|
|
This project uses the following technologies/standards.
|
|
|
|
|
Please read and understand them before starting.
|
|
|
|
|
|
|
|
|
|
- [JavaScript](mdn-js) - The programming language.
|
|
|
|
|
- [Yarn][yarn] - Package manager
|
2017-11-21 05:12:43 -08:00
|
|
|
- [Web-ext][web-ext] - CLI Web-ext tool
|
2017-11-18 17:04:14 -08:00
|
|
|
|
2017-11-21 05:12:43 -08:00
|
|
|
## Setting up your environment
|
|
|
|
|
|
|
|
|
|
You will just need to install project and component dependencies via yarn
|
|
|
|
|
|
|
|
|
|
Slate remove your node_modules and do a clean install
|
|
|
|
|
```sh
|
|
|
|
|
npm run slate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Try on a browser
|
|
|
|
|
|
|
|
|
|
To try it on a browser, you just need to start the with the command below and set your shaarli URL.
|
|
|
|
|
```sh
|
|
|
|
|
npm run start # web-ext run
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Running Tests
|
|
|
|
|
|
|
|
|
|
There is no tests for now.
|
|
|
|
|
|
|
|
|
|
## Linting
|
|
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
This will create a xpi that can be submitted on [addons.mozilla.org](https://addons.mozilla.org/fr/firefox/)
|
|
|
|
|
```sh
|
|
|
|
|
npm run build # web-ext build
|
|
|
|
|
``
|
2017-11-18 17:04:14 -08:00
|
|
|
|
|
|
|
|
[yarn]: https://yarnpkg.com/en/docs/install "Package manager"
|
2017-11-21 05:12:43 -08:00
|
|
|
[web-ext]: https://www.npmjs.com/package/web-ext "CLI Web-Ext tool"
|
