Skip to content

Commit

Permalink
v1.0.0 - Public release
Browse files Browse the repository at this point in the history
  • Loading branch information
jodyheavener committed Feb 5, 2019
0 parents commit a73396d
Show file tree
Hide file tree
Showing 57 changed files with 9,923 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"presets": ["@babel/env", "@babel/preset-react"]
}
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# build artifacts
dribbble.sketchplugin

# npm
node_modules
.npm
npm-debug.log

# mac
.DS_Store

# WebStorm
.idea

.env
.env.development
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Dribbble Plugin for Sketch

### What you'll need

- Sketch
- Node >=6.9.5 and NPM
- skpm

### Developing this plugin

This plugin is built using [spkm](https://github.com/skpm/skpm). Go ahead and get familiar with it. For development just know it's:

- Essentially just A Webpack development setup
- A React app that talks to the Sketch environment
- Entirely ES6 friendly

To get started, set up an `.env` file with the following keys (fill in the values yourself):

```
SITE_URL=
API_URL=
API_CLIENT_KEY=
SEGMENT_WRITE_KEY=
DEV_BASIC_AUTH= // optional
```

Afterward you can get set up by running the following command.

```bash
// Install the dependencies
npm install

// Once the installation is done, you can run some commands inside the project folder:
npm run build

// To watch for changes:
npm run watch

// Additionally, if you wish to run the plugin every time it is built:
npm run start
```
### Creating releases
This will change in the future but for now just do the following:
- Version bump in `package.json`
- Delete your build folder and run `NODE_ENV=production npm run build` to get a production version of the code
- Zip it and [create a Release](https://github.com/dribbble/dribbble-sketch/releases/new)
Loading

0 comments on commit a73396d

Please sign in to comment.