https://github.com/baybara-pavel/zero

Boilerplate for Zeplin extension projects based on webpack
https://github.com/baybara-pavel/zero

boilerplate extension webpack zeplin zeplin-extension

Last synced: 3 months ago
JSON representation

Boilerplate for Zeplin extension projects based on webpack

• Host: GitHub
• URL: https://github.com/baybara-pavel/zero
• Owner: baybara-pavel
• License: mit
• Created: 2018-02-25T15:45:28.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-09T06:38:42.000Z (almost 7 years ago)
• Last Synced: 2024-10-24T16:49:46.604Z (3 months ago)
• Topics: boilerplate, extension, webpack, zeplin, zeplin-extension
• Language: JavaScript
• Homepage:
• Size: 57.6 KB
• Stars: 17
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        








  

    

  



Start your Zeplin extension from Zero with Webpack.


If you want more power features without build process configuration – use official solution [zem](https://github.com/zeplin/zem)

## Zero includes

* Base project file structure

* Webpack (dev watching & production minification)

* Babel

* Prettier

* Eslint (AirBnB & Prettier)

* EditorConfig

* Husky & Lint-staged (pre-commit hooks)

## How to Start

First, you need last stable Node.js `^8.9.4`. Follow this [guide](https://github.com/creationix/nvm/blob/master/README.md#installation) if you don't have any.

Next, install project dependencies:

```bash

npm install

```

To start developing run:

```bash

npm start

```

Result build will be at `dist` dir. To add your extension into local macOS Zeplin client follow the instruction from official [tutorial](https://github.com/zeplin/zeplin-extension-documentation/blob/master/tutorial.md#adding-a-local-extension). Path to your local extension be like:

```

file://[absolute_path_to_zero_project_folder]/dist/manifest.json

```

Don't forget to replace `[absolute_path_to_zero_project_folder]` with your folder absolute path.

And finally, to get production ready build of your extension, just replace Zero credantials in `src/manifest.json` to yours and run following:

```bash

npm run build

```

## Project structure

```

zero

├── README.md

├── node_modules

├── package.json

├── package-lock.json

├── .eslintrc.js

├── .eslintignore

├── .prettierrc

├── .editorconfig

├── .gitignore

├── config

│   └── paths.js

│   └── webpack.common.js

│   └── webpack.dev.js

│   └── webpack.prod.js

├── dist                  <-- result extension build will be there

│   └── index.js

│   └── manifest.json

└── src

    └── _example-lib.js

    └── index.js

    └── manifest.json

```

## Extensions builded with Zero

* [Zepcode](https://github.com/artemnovichkov/zepcode) - Zeplin extension that generates Swift snippets from colors, fonts and layers

## Authors

Baybara Pavel, [email protected]

Artem Novichkov, [email protected] [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/artemnovichkov?utm_source=github&utm_medium=button&utm_term=artemnovichkov&utm_campaign=github)

## License

Zero is available under the MIT license. See the LICENSE file for more info.