@alzintani/superevents/CONTRIBUTING.md

JavaScript library that handling any events in websites.

## Contributing
Want to get involved with SuperEvents? Here's how you can help.

[Fork](https://help.github.com/fork-a-repo/) SuperEvents, clone your fork, and configure the remotes:

```BASH
# Get code from repostery
git clone https://github.com/<your-username>/SuperEvents.git

# Change your way to cloned directory
cd SuperEvents

# Configure the remotes
git remote add upstream https://github.com/alzintani/SuperEvents.git
```


Install required packages `npm install` then run `npm run build` to build main files and documentation files.

Now you can run `npm start`

To display the documentation go to [http://localhost:3001](http://localhost:3001) from your browser.