diff --git a/README.md b/README.md index 10a491e..b7d065a 100644 --- a/README.md +++ b/README.md @@ -1,135 +1,79 @@
- - -

PhysicsHub

-

Learn physics the visual way โ€” interactive simulations, clear theory and free resources.

- -

- - Stars - - - Forks - - - Issues - - - License - - Contributors -

- -

- - Live Site - -

- ---- - -### โญ If PhysicsHub helps you learn, please consider giving it a star โ€” it helps the project grow! - -[![Star this repo](https://img.shields.io/github/stars/PhysicsHub/physicshub.github.io?style=social)](https://github.com/PhysicsHub/physicshub.github.io/stargazers) - -
- ---- - -## ๐Ÿ“ธ Preview - -

- PhysicsHub Screenshot + +

PhysicsHub

+

Best website to learn physics easily, with cool interactive simulations.

+

+Contributors +Forks +Stars +Issues +Languages +Repository Size

- ---- + ## ๐Ÿ“š About -![Stack Fingerprint](https://stackfingerprint.vercel.app/api/card?repo=physicshub/physicshub.github.io&theme=abyss&layout=classic&size=md&icons=icononly&pills=round) - -**PhysicsHub** is a free, open-source web app that makes physics accessible through interactive simulations and clearly written theory. Whether you're a student preparing for exams or just curious about how the universe works, PhysicsHub makes complex formulas click. - -- ๐Ÿ”ฌ **Interactive simulations** to visualize physics concepts in real time -- ๐Ÿ“– **Easy-to-understand theory** written for learners, not textbooks -- ๐Ÿ†“ **Completely free** โ€” no ads, no paywalls, no accounts needed -- ๐ŸŒ **Open source** โ€” built by the community, for the community - ---- - -## ๐Ÿš€ Quick Start - -Try it instantly in your browser โ€” no setup needed: - -๐Ÿ”— **[physicshub.github.io](https://physicshub.github.io)** - ---- - -## ๐Ÿ› ๏ธ Run Locally - -Want to contribute or explore the codebase? Get up and running in minutes: +A small web application to help student understand physics with cool interactive simulations and easily understandable theory. -```bash -# 1. Clone the repository -git clone https://github.com/physicshub/physicshub.github.io.git -# 2. Navigate to the project directory -cd physicshub.github.io +## ๐ŸŒ Live Demo -# 3. Install dependencies -npm install -# or -yarn install +Try PhysicsHub directly in your browser: +๐Ÿ”— **[Visit the Website](https://physicshub.github.io)** -# 4. Start the development server -npm run dev -``` +

+ PhysicsHub Screenshot +

-Then open **http://localhost:3000** in your browser. That's it! ๐ŸŽ‰ ---- +## ๐Ÿ› ๏ธ Steps to run it locally + +1. Clone the repository to your computer
+ ``` bash + git clone https://github.com/physicshub/physicshub.github.io.git +2. Navigate to the app directory
+ ``` bash + cd physicshub.github.io +3. Install the necessary dependencies
+ ```bash + npm install + # or + yarn install + ``` +6. Start the local development server
+ ```bash + npm run dev +7. Open your browser to http://localhost:3000 ## ๐Ÿค Contributing -We love contributions โ€” and this project is **perfect for first-time contributors!** - -Here's how you can help: - -| Type | Description | -| ------------------------- | ------------------------------------------ | -| ๐Ÿ› **Bug Report** | Found something broken? Open an issue | -| ๐Ÿ’ก **Feature Request** | Got an idea for a new simulation? Share it | -| ๐ŸŽจ **UI/UX Improvements** | Make the interface more beautiful | -| ๐Ÿ“ **Theory Content** | Write or improve physics explanations | -| ๐Ÿ”ง **Code Fixes** | Pick up an open issue and submit a PR | - -๐Ÿ“– Read the full **[Contributing Guide](https://github.com/physicshub/physicshub.github.io/blob/main/CONTRIBUTING.md)** before getting started. - ---- - -## โญ Star History - -If you find PhysicsHub useful, **starring the repo** is the simplest and most impactful way to support us โ€” it helps more students and contributors discover the project. +We welcome contributions from the community! +We welcome all kinds of contributions: +- ๐Ÿ› **Report a bug** +- ๐Ÿ’ก **Suggest a new feature or simulation** +- ๐ŸŽจ **Improve the UI/UX** +- ๐Ÿ“ **Write theory content** +- ๐Ÿ”ง **Fix an existing issue** +and more... -[![Star History Chart](https://api.star-history.com/svg?repos=PhysicsHub/physicshub.github.io&type=Date)](https://star-history.com/#PhysicsHub/physicshub.github.io&Date) +Our project is **perfect for first-contribution!** ---- +Check the [***FULL GUIDE***](https://github.com/physicshub/physicshub.github.io/blob/main/CONTRIBUTING.md) for starting now! -## ๐Ÿ‘ฅ Contributors -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. We recognize **all types** of contributions โ€” not just code! +
+
-To add yourself after contributing, comment on any issue or PR: +### ๐Ÿ‘ฅ Contributors -``` -@all-contributors add @YOUR-USERNAME for code, design, content -``` +We recognize all types of contributions. This project follows the [all-contributors specification](https://github.com/all-contributors/all-contributors) and the [Emoji Key](https://allcontributors.org/docs/en/emoji-key) โœจ for contribution types. Instructions to add yourself or add contribution emojis to your name are [here](https://github.com/physicshub/physicshub.github.io/issues/25). You can also post an issue or comment on a pull request with the text: `@all-contributors add @YOUR-USERNAME for THINGS` (where `THINGS` is a comma-separated list of entries from the [list of possible contribution types](https://github.com/all-contributors/all-contributors/blob/master/docs/emoji-key.md)) and all-contributors bot will add you. -Or see the [full instructions here](https://github.com/physicshub/physicshub.github.io/issues/25). +Contribution list sorted by amount of commits: +[![Contributors](https://raw.githubusercontent.com/physicshub/physicshub.github.io/main/images/contributors.png)](https://github.com/physicshub/physicshub.github.io/graphs/contributors) -**Contributions sorted by additions:** -[![Contributors](https://raw.githubusercontent.com/physicshub/physicshub.github.io/main/images/contributors.png)](https://github.com/physicshub/physicshub.github.io/graphs/contributors) +Contribution list sorted by order of contribution and based on what they did: @@ -166,8 +110,6 @@ Or see the [full instructions here](https://github.com/physicshub/physicshub.git Talos0248
Talos0248
๐Ÿ› Efstratios Kassaras
Efstratios Kassaras
๐ŸŽจ - Etienne
Etienne
๐Ÿ’ป - Nitin Tanwar
Nitin Tanwar
๐Ÿ’ป ๐Ÿ› @@ -177,43 +119,30 @@ Or see the [full instructions here](https://github.com/physicshub/physicshub.git ---- -## ๐Ÿ’– Support the Project +### ๐Ÿ’– Supporters -PhysicsHub is and will always be **free and open-source**. If it's been helpful to you, here are the best ways to support us: +PhysicsHub is and will always be free and open-source. If you find it helpful, consider supporting us to help fuel future development. -| Action | Impact | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| โญ [Star this repo](https://github.com/PhysicsHub/physicshub.github.io/stargazers) | Helps others discover the project | -| ๐Ÿ”€ [Fork & contribute](https://github.com/physicshub/physicshub.github.io/blob/main/CONTRIBUTING.md) | Makes the project better for everyone | -| ๐Ÿ“ฃ Share with friends | Spreads the word to students who need it | -| โ˜• [Donate on Ko-Fi](https://ko-fi.com/W7W41MA4Y1) | Helps us get a custom domain & beyond | +> โš ๏ธ **Note:** +> +> Hello everyone,\ +> I am the owner of this project. +> +> If we were to receive a substantial amount of donations, or monthly donations, the project could have its own domain. +> But if you have any idea of what to do with donation, we will be very happy to hear your opinions. +> If you can't support us financially, just share the site and the project with anyone, in person or on social media. -> ๐Ÿ’ฌ _Have ideas for what donations should fund? We'd love to hear from you โ€” open a discussion or join our Discord!_ +Become a supporter by donating on Ko-Fi: [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/W7W41MA4Y1) ---- - -## ๐ŸŒ Community - -Questions, ideas, or just want to chat? Join our Discord! +### ๐ŸŒ Community +Have questions, ideas, or just want to chat about this website? Join our Discord server! -[![Discord](https://dcbadge.limes.pink/api/server/hT68DTcwfD)](https://discord.gg/hT68DTcwfD) +[![](https://dcbadge.limes.pink/api/server/hT68DTcwfD)](https://discord.gg/hT68DTcwfD) ---- -## ๐Ÿ“œ License +### ๐Ÿ“œ License -Distributed under the **MIT License**. See [`LICENSE`](https://github.com/PhysicsHub/physicshub.github.io/blob/main/LICENSE) for details. - ---- - -
- Made with โค๏ธ by the PhysicsHub community ยท physicshub.github.io -

- - Star on GitHub - -
+Licence