AnimateHub
Visit URL for live demo :- https://animate-hub.vercel.app/
### :star2: About
**Animate Hub** is your go-to resource for all things animation in web development. Discover a wide range of code snippets for animations, hovers, and effects, designed to streamline your workflow. Just copy, paste, and watch your projects come to life!
### :outbox_tray: How to Set up Project locally :
1. Clone the repo
```sh
git clone https://github.com/Premkolte/AnimateHub.git
```
2. Go to the project folder
```sh
cd AnimateHub
```
3. Install NPM packages
```sh
npm install
npm install react-darkreader --legacy-peer-deps
```
4. Run development server
```sh
npm run dev
```
### Alternatively contribute using GitHub Desktop
1. **Open GitHub Desktop:**
Launch GitHub Desktop and log in to your GitHub account if you haven't already.
2. **Clone the Repository:**
- If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
- Choose the repository from the list of repositories on GitHub and clone it to your local machine.
3. **Switch to the Correct Branch:**
- Ensure you are on the branch that you want to submit a pull request for.
- If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
4. **Make Changes:**
Make your changes to the code or files in the repository using your preferred code editor.
5. **Commit Changes:**
- In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
- Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to
" button to commit your changes to the local branch.
6. **Push Changes to GitHub:**
After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
7. **Create a Pull Request:**
- Go to the GitHub website and navigate to your fork of the repository.
- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
8. **Review and Submit:**
- On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
- Once you're satisfied, click the "Create pull request" button to submit your pull request.
9. **Wait for Review:**
Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.
### :building_construction: How to Contribute ?
**Choose an Issue**
1. Pick an issue that interests you.
2. Comment on the Issue, and explain why you want to work on it.
**Set Up Your Environment**
1. `Fork` our repository to your GitHub account.
2. `Clone` your fork to your local machine.
Use the command `git clone `.
3. Create a new branch for your work .
**Commit Your Changes**
- Commit your changes with a _clear commit message_.
**Submit a Pull Request**
- Push your branch and changes to your fork on GitHub .
- Create a pull request, compare branches and submit.
- Provide a detailed description and screenshots of what changes you've made and why.
Link the pull request to the issue it resolves. 🔗
**Review and Merge**
- Our team will review your pull request and provide feedback or request changes if necessary.
- Once your pull request is approved, we will merge it into the main codebase 🥳
Ready to Contribute?
Kindly go through [CONTRIBUTING.md](CONTRIBUITING.md) to understand everything from setup to contributing guidelines.
If you would like to contribute to the project, please follow our contribution guidelines.
### :file_folder: File Structure
```
.
│
├── src
│ ├── components
│ | ├── SnippetComponents
│ | | ├── Snippets
│ | | | ├── Buttons.js
│ | | | ├── Cards.js
│ | | | ├── Checkboxes.js
│ | | | └── ... // other snippet objects
| | | |
│ │ | ├── ButtonSnippets.jsx
│ │ | ├── CardSnippets.jsx
│ │ | ├── CheckboxSnippets.jsx
│ │ | └── ... // other snippet components
| | |
│ │ ├── Card.jsx
│ │ ├── Modal.jsx
│ │ ├── SideBar.jsx
│ │ └── Window.jsx
│ │
│ ├── App.jsx
│ ├── main.jsx
│ └── index.css
│
├── .gitignore
├── index.html
├── package.json
├── LICENSE
├── README.md
└── ... // other config files
```
Code of Conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Open Source Programs
|
VSOC 2024
|
|
This project is part of Vinyasa Summer of Code. We welcome contributions from the community.
|
License
This project is licensed under the MIT License.
Show Your Support
If you find this project interesting and inspiring, please consider showing your support by starring it on GitHub! Your star goes a long way in helping us to reach more developers and encourages to keep enhancing the project.
Contributors
Thank you for contributing to our project! Your help is greatly appreciated in making AnimateHub even better. 😊