diff --git a/README.md b/README.md index 187a138..47afb96 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# AI Fusion - Your One-Stop Destination for All AI Resources! +
-Welcome👋 +# AI Fusion - Your One-Stop Destination for Inclusive AI Resources! -AI Fusion is your ultimate destination for streamlined access to a curated collection of powerful AI tools and prompts. With direct links to a variety of resources, our website eliminates the hassle and empowers you to effortlessly enhance your productivity. +
![banner](./github-assets/banner.jpeg) +# Welcome👋 + > Here is the preview of the website https://aifusion.vercel.app ## 💻 Tech Stack @@ -14,16 +16,52 @@ AI Fusion is your ultimate destination for streamlined access to a curated colle - [TypeScript](https://www.typescriptlang.org/) - TypeScript is an open-source language which builds on JavaScript, one of the world’s most used tools, by adding static type definitions. - [Tailwind CSS](https://tailwindcss.com) - Tailwind CSS is an open-source CSS framework. -## 🚀 Quick start -Contributions are welcome! If you have any ideas, suggestions, or bug fixes, please open an [issue](https://github.com/PriyansuMaurya/AI-Fusion/issues) or submit a pull request. Make sure to follow the project's code of conduct. +# 🚀 Getting Started! +## How To SetUp +- Fork The Repo +``` +just click on the green fork button on the top +``` +- Clone your forked repo +``` +$ git clone +``` +- Go to directory +``` +$ cd AI-Fusion +``` +- Install Dependencies +``` +$ npm install +``` +- Start LocalHost Server +``` +$ npm run dev +``` + +## 🤝 How To Contribute! + +Contributions are welcome! If you have any ideas, suggestions, or bug fixes, please open an [issue](https://github.com/PriyansuMaurya/AI-Fusion/issues) or submit a pull request. We greatly appreciate any work contributed, no matter how big or small it is!. Make sure to follow the project's code of conduct. + +### Issues & Pull Requests +When you are ready to start work on an issue: +- Let us know by leaving a comment on the issue (or you can also raise a new issue if you want to work on something completely new in the project) +- Once you are assigned the issue (or once you have claimed the issue) only then proceed to make the Pull Request. This will help avoid multiple PRs pertaining to the same issue. +- Go through the [CONTRIBUTING.md](/CONTRIBUTING.md) file, where all the guidelines have been mentioned that will guide you to make your contribution. +- Do check out the [project issue tracker](https://github.com/PriyansuMaurya/AI-Fusion/issues) section. > **Note**: If you are new to open source contributions, you can refer to [this](https://opensource.guide/how-to-contribute/) guide by GitHub. > **Warning**: Please do not spam the repository with unnecessary PRs. Make sure to follow the project's [code of conduct](/CODE_OF_CONDUCT.md). -- Go through the [CONTRIBUTING.md](/CONTRIBUTING.md) file, where all the guidelines have been mentioned that will guide you to make your contribution. -- Do check out the [project issue tracker](https://github.com/PriyansuMaurya/AI-Fusion/issues) section. +## Contribute Easily with Gitpod 🚀 + +Simply click the button below, and Gitpod will take care of everything, ensuring that all the necessary dependencies are installed, the project is running, and you are ready to contribute. + +[![Gitpod Ready-to-Code](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/new/#https://github.com/PriyansuMaurya/AI-Fusion.git) + +Enjoy the simplicity and ease of contributing with Gitpod! ## 🫂 Contributors @@ -44,3 +82,5 @@ Thank you for your interest in contributing to our project! We appreciate any co ## ©️ License Our project is licensed under the [MIT license](./LICENSE). By contributing, you agree that your contributions will be licensed under its MIT license. + +

(Back to top)

diff --git a/gitpod.yml b/gitpod.yml new file mode 100644 index 0000000..226674d --- /dev/null +++ b/gitpod.yml @@ -0,0 +1,16 @@ +tasks: + - init: npm install && npm run build + command: npm run dev + +github: + prebuilds: + addBadge: true + addComment: false + addCheck: true + master: true + branches: true + pullRequestsFromForks: true + +ports: + - port: 3000 + onOpen: open-preview \ No newline at end of file