Giter Club home page Giter Club logo

starterhive's Introduction

Starter Hive ✨

License

GitHub Header

🚀 Simplifying and Guiding First Contributions for Beginners 🚀

Welcome to Starter Hive! This project aims to make it easier for beginners to make their first contributions. Whether you're new to programming or looking to contribute to open-source projects, this repository provides the necessary resources and guidance.

💻 Tech Stack

Client: React , TailwindCSS

Server: Node, Express

📖 Table of Contents

🤝 Contributing

Follow these steps to contribute to the project:

  • Step 1

    Fork this repository

fork

  • Step 2:

    Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

clone

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

opy

The code will look something like this :

git clone https://github.com/{your user name}/StarterHive.git
  • Step 3:

    Navigate to StarterHive on your device

    cd StaterHive/
  • Step 4:

    • Add an upstream link to the main branch in your cloned repo
    git remote add upstream https://github.com/ArslanYM/StarterHive
    • Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
    git pull upstream main
  • Step 5:

    Create your feature branch (This is a necessary step, so don't skip it)

    git checkout -b <feature-name>
  • Step 6: Make necessary changes and commit those changes

    Add your commits to the staging

    git add .
    
  • Step 7: Commit the changes

    • Now commit those changes using the git commit command:
    git commit -m "Write a meaningful but small commit message"
    • Follow this Guide for commit messages.
  • Step 8: Push your code.

    Push your changes using the command git push :

    git push -u origin your-branch-name
  • Step 9:

    Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

New to open-source?

You can also contribute to this project if you are new to open source:

🧑‍💼 Project Admin

Arsalan
Arslan Malik

👥 Project Mentors

Nadeem
Nadeem

✨ Contributors

Thank you for your dedication and hard work. Your contributions are invaluable to our team, and we are so grateful for all that you do. Your hard work and dedication are truly admirable. Thank you for your unwavering commitment and for all that you do for our team.

Please visit Contributors to check the list of contributors and add your name to the list to become a contributor.

Contributors

🎨 Frontend Development

Calling all Frontend developers! We invite you to contribute to the web/ directory of this project. The web/ directory contains all the frontend code and assets. Whether you're experienced or just starting with frontend development, your contributions are highly appreciated.

Feel free to explore the web/ directory, make improvements, fix bugs, or add new features. Don't hesitate to share your ideas and suggestions to enhance the user experience.

To contribute to the Frontend development:

  1. Fork this repository.
  2. Make your changes in the web/ directory.
  3. Submit a pull request explaining the changes you made and why they are valuable.

Let's work together to create an amazing frontend experience for our users!

📝 Guidelines

Please ensure that you adhere to the project's guidelines while making contributions. You can find detailed guidelines in the Guidelines document.

📄 License

Starter Hive is licensed under the MIT License. For more information, please see the LICENSE file.


Thank you for choosing Starter Hive! We hope this repository helps you in your journey as an open-source contributor. Let's create amazing things together! ✨

starterhive's People

Contributors

aashay28 avatar agmarcos5 avatar alimurtuzacodes avatar amanrajrana avatar arslanym avatar ashwanthramkl avatar ayush-chandil avatar harshsbhandari avatar henrique-mazzoleni avatar kaleemullah786 avatar kaur-rajdeep avatar keshav-aneja avatar kruthardh11 avatar lokeshkadem avatar love-sonkar avatar marcelorafaelfeil avatar masif2002 avatar muhammadrabi avatar nadeem099 avatar poorvijn avatar promise-dash avatar rahilansari261 avatar realazaber avatar shubh8899 avatar sohoxic avatar thgnommy avatar turtlebeasts avatar vijaynaidu16 avatar yacdanycr avatar yashhhh04 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

starterhive's Issues

⭐FEAT: Improve the issue card design

TODO:

Need improvements in the design of the issue cards as it is the main feature of the website.

  • It has to be appealing and should have good ux.
  • As much information as possible about the issue should be displayed in the card itself without opening the issue link, at the same time it should not be flooded with lot of info as it will affect the ux.

🔴 BUG: Hero button doesn't work

Describe the bug
The button in the hero section doesn't take the user to the github issues.

To Reproduce
Steps to reproduce the behavior:

  1. Go to the hero section
  2. Click on "Find issues" button
  3. Nothing will happen

Expected behavior
The user should be taken to the github issues when clicking on the button

⭐FEAT: Add svg in footer

TODO :

  • Add Starter Hive Svg In footer.
  • (Link to svg)[https://github.com/ArslanYM/StarterHive/blob/main/web/public/hive.svg]
  • Add it here :
    svvg

⭐FEAT:Making the Header look more attractive

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is.
push the startedHive Text from top to the left and move the navbar links on the same side as the github links, I was thinking if making the navbar sticky and translucent with some box shadow so when the user scrolls down as we add more components, the navbar is consistent with his movements and the translucent background makes it look more attractive.

Adding some additional hover effects also works out on the navbar links

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered

Additional context
Please share your suggestions, something additional that you want me to add or dont want me to add

⭐FEAT: Add divs to the hero section

#TODO:

  • Add better looking divs to the main hero section instead of existing one div.
  • For example :
    Screenshot_2023-05-24_210450

The divs should be placed like this and later we must be able to insert an cover image inside.

🔴 BUG: Button with less padding

Description

Feel like the padding on this button is a bit too less
image

Steps to Reproduce

  1. Go to the website
  2. Take a look at the GitHub button on the NavBar

Proposed Change

image

Note: I have also removed the Arrow icon in the proposal

[FEAT] Add a folder structure to the project

I suggest to go with the basic and beginner friendly "grouping by file type" folder structure.

  • src
    • assets
    • components
      • Button.jsx
      • Card.jsx
      • index.js
    • contexts
    • helpers
    • layouts
    • pages

pages: pages will be combination of multiple components and will be mapped to a specific app route. This is helpful for beginners and new commers as it will be the entry point of application and through this folder they will be able to navigate to the rest of the codebase.

every folder will have index.js file in it which will export all the necessary functions/components required outside the folder.

optionally we can introduce hoc, hooks and __tests__ if we need in future but we should avoid as it's not easy for beginners to understand.

To keep the codebase clean and maintainable:

  • We should avoid importing from other than index.js file of a specific folder.
  • Avoid creating nested folders, try to avoid more nesting at all.
  • Keep the files in the correct folder according to their types.

⭐FEAT: Rearranging/Changing the styling of the text in the hero section.

The text section in the home page can be made more attractive and prettier. The text together looks congested. Some padding and spacing will make this look good.

I would like to change the font and and little bit of shades to highlight keywords. Animation can also be added to the next and the button.
sh-1-edited

⭐FEAT: Add a list of issues

TODO

  • Add a list of issues as a json object, which will be used to add issues manually in the website.
  • Render the issue cards on the issue page.

🔴 BUG: Cursor is not a pointer in NavBar

Describe the bug
Hovering on to "Home", "Contributors", "Docs" and "Find Issues" cursor is not a pointer.

To Reproduce
Steps to reproduce the behavior:
hover on any thing on navbar

Expected behavior
As per better UX it should be pointer

Assign this to me will give it after doing the change.

⭐FEAT: Add a section in the main Readme file

TODO:

  • Add a section in the readme that navigates/points to Contributors.md file where first timers can add thier names to the file and make a contribution
  • Add a section in the readme asking frontend developers to contribute to web/ directory.

🔴 BUG: White, bar present beneath the footer, after device-height exceeds 993.328px with a ratio of 1, specifically visible on MacBook Air M2 (2022) with safari.

Describe the bug
There is a big white bar, that is visible on safari browsers
The Black bar is the device frame and the red bar is where the white bar can be observed.
To Reproduce
Steps to reproduce the behavior:

  1. Grab a M1/M2 Macbook Air
  2. Open the verbal deployment
  3. Scroll down form then footer to see the whitespace

Expected behavior
No white Space beneath the nabber should be present.

Screenshots
Screenshot 2023-05-24 at 2 22 24 PM
Additional context
This does not appear to be a use agent problem as it is not present on the intel/mobile platform, I believe, it could only be limited to safari or it could be a major, css problem, further analysis is required.

⭐FEAT: Add images to the hero divs

TODO:

  • Add images to divs in the main hero section.
  • add more divs to fill the right portion of the hero section. Will provide more images later.
    here:
    Screenshot 2023-05-27 114139

images:

Penguinxz1_a_man_wearing_hoodie_not_showing_his_face_coding_in__09a58591-376a-468f-8541-7dc016f59dbf
Penguinxz1_a_man_wearing_hoodie_not_showing_his_face_coding_in__ae92f84a-ed5b-4410-96a7-eb8bc366e483
Penguinxz1_many_coding_community_peoples_in_a_futuristic_coding_9dd7c244-3ba7-4462-bc2c-778aa751ccb0
Penguinxz1_many_coding_community_peoples_standing_facing_camera_18d12f28-5e87-4972-b957-f196e32b247f

🔴 BUG: navbar and hero section both are not aligned properly

Describe the bug
navbar and hero section both are not aligned properly Hero section has too much space to its left side

To Reproduce
Steps to reproduce the behavior:

  1. Go to home page

Expected behavior
both hero section and navbar should align together properly

🔴 BUG: Stand out effect instead of stand in.

TODO:

  • on hover over the "open source" text in hero section, the text should stand out in animation instead of becoming smaller. Kind of like a float up.
  • The opposite of how its behaving cuurently.
    instrea

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.