Skip to content

Commit

Permalink
docs(example): add example project
Browse files Browse the repository at this point in the history
  • Loading branch information
bibixx committed Dec 31, 2020
1 parent b79a1ff commit 002ada9
Show file tree
Hide file tree
Showing 15 changed files with 18,173 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
build
build
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
yarn-error.log
build/
yarn.lock
.eslintcache
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

## Examples

* [Simple implementation (codesandbox.io)](https://codesandbox.io/s/react-adobe-animate-zw61y)
* [Simple implementation (codesandbox.io)](https://githubbox.com/bibixx/react-adobe-animate/tree/master/examples)

## Dependencies

Expand Down Expand Up @@ -95,7 +95,11 @@ Unfortunately it isn't possible to export from Adobe Animate two unique animatio

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/bibixx/react-adobe-animate/issues).
Contributions, issues and feature requests are welcome!\
Feel free to check [issues page](https://github.com/bibixx/react-adobe-animate/issues).

For development purposes you can use the `example` folder. \
You'll find instructions on how to use it in [`example/README.md`](https://github.com/bibixx/react-adobe-animate/blob/master/example/README.md)

## Show your support

Expand Down
23 changes: 23 additions & 0 deletions example/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
45 changes: 45 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<h1 align="center">Adobe Animate React component example</h1>

In this folder you can find an example project that uses the `react-adobe-animate` package. You can use it as a reference or for development.

## Available Scripts

In the project directory, you can run:

### 👨‍💻 `npm run link`

When in development you can use this command to link the example app with the development build of the package.

Alternatively you can move to the root folder of the package and run
```bash
npm link
```

Then when in example folder run
```bash
npm link react-adobe-animate
```

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).
Loading

0 comments on commit 002ada9

Please sign in to comment.