Contributing

If there is something I missed, a mistake, or a feature you would like added please create an issue or a pull request and I’ll try to get to it.

Warning: all contributions must be done on the beta branch. By default Gitpod will open on the beta branch, but still keep this in mind.

Note: To properly understand the inner working of @okikio/animate, please read up on the Web Animation API.

The native initiative uses Changesets, for versioning and Changelog generation, you don’t need to create one, but it would be amazing if you could.

Using Gitpod

You can try out @okikio/animate using Gitpod:

You can start the dev script by typing into the terminal,

pnpm start

pnpm start will launch a small demo website built using Astro, all changes to the build folder should be reflected live (you may need to reload the webpage if your changes aren’t appearing).

Note: I used Astro & solidjs for the demo website, you may need to go through those resources before you understand how the demo works.

Once Gitpod has booted up, go to the demo folder and start tweaking and testing to your hearts content.

Runing Locally

You can run @okikio/native locally by first installing some packages via these commands into your terminal,

npm install -g pnpm
pnpm install -g ultra-runner
pnpm install

You can test your changes/contributions using,

pnpm start

You can build your changes/contributions using,

pnpm build

Note: I used Astro & solidjs for the demo website, you may need to go through those resources before you understand how the demo works.

Once Gitpod has booted up, go to the demo folder and start tweaking and testing to your hearts content.