Skip to content

Latest commit

 

History

History
144 lines (97 loc) · 5.85 KB

README.md

File metadata and controls

144 lines (97 loc) · 5.85 KB
Raw

Note:

UI of site is under-development

Web Resource Hub 👨‍💻

🚀 About

  • Web Resource Hub is an open-source project developed for the DevJam Hackathon organized by Social Summer of Code.
  • It serves as a comprehensive collection of frontend web resources, including HTML, CSS, JavaScript, and React.
  • The project aims to provide developers with a centralized platform to access a wide range of frontend tools and resources, making their development process more efficient and productive.

Deployed Links

Main -> https://web-resources-hub-project.vercel.app/

Dev -> https://web-resources-project-dev.vercel.app/

qa -> https://web-resources-project-qa.vercel.app/

📷 Screenshot

Screenshot 2023-05-15 094313

🛠️ Tech Stack

React TailwindCSS

✅ Getting Started

  1. Fork the project,click on create new fork. s3

  2. To clone the repository to your local machine, follow these steps:

  3. Click on the "Code" button. s1

  4. Copy the HTTPS Link. s2

  5. Open the terminal or command prompt on your computer.

  6. Navigate to the directory where you want to clone the repository.

  7. Type the command git clone [https://github.com/<your_github_username>/web-resources-project.git] (This will download the repository to your local machine)

⬇️ Prerequites

  • Node JS
  • pnpm

👉 Running the Project Locally

  1. Open a terminal or command prompt on your computer.
  2. Navigate to the directory where the repository was cloned.
  3. Run the following command: pnpm install (This command installs the project dependencies).
  4. After the installation is complete, run the following command: pnpm dev (This command launches the project in your local browser or terminal).

💪 Adding new resource

  1. Navigate to the database folder in the src folder.
  2. Navigate to the appropriate section directory (videos, websites or challenges etc) based on the type of resource you want to add.
  3. Each directory has technology json file
  4. Create a new object for your resource in the appropriate json file.
  5. Add the details of your resource: Here's an example
{
    "title": "CodeWell",
    "description": "Improve your HTML and CSS skills by practicing on real design templates.With Codewell, you can browse high quality Figma templates that you can use to sharpen your HTML and CSS skills.",
    "link": "https://www.codewell.cc/",
    "img": "https://user-images.githubusercontent.com/100681165/238244473-00725538-ef4d-4ece-8fd7-11e6b999b895.png"
  },

🖼️ Adding images

The size of the image should be less than 300 Kb

  1. Navigate to the public/Card Images
  2. There you will find folders of all the sections, navigate to the appropriate folder.
  3. Each folder has a .md file
  4. Drag and drop your image in the .md file in the appropriate position.

Note: The size of the image should be less than 300 KB.

🤝 Contributing

We welcome contributions from the community! If you're interested in contributing to this project, please read our Contributing Guidelines for more information on how to get started.

Project Admins


Jay Gupta

Project Mentors


Debajit Mallick

Varun Singh

Our Contributors !! ✨

Thanks to these wonderful people: ✨

My Awesome Project

🌟 If you find this project helpful or interesting, please consider giving it a star! 🌟

Starring the repository helps to raise awareness and attract more users. It shows your appreciation for the project and provides motivation for further development and improvements. It's a simple way to show support!

To star this repository, simply click on the Star button at the top-right corner of the page. Thank you for your support! 😊

License

MIT License. This project is licensed under the MIT License.