Giter Club home page Giter Club logo

pbclife / gitopener.vercel.app Goto Github PK

View Code? Open in Web Editor NEW
44.0 1.0 33.0 3.03 MB

Git Opener is a learning web app if you are looking forward to get started with open source then you are in right place. Please read contribution guideline.

Home Page: https://gitopener.vercel.app

License: MIT License

JavaScript 5.03% TypeScript 67.20% CSS 4.13% Shell 0.06% MDX 23.59%
nextjs react typescript headlessui monggose mongodb tailwindcss zod api beginner-friendly

gitopener.vercel.app's Introduction

GitOpener πŸšͺπŸ”“

Open in GitPod License: MIT Contributors GitHub Repo stars GitHub forks GitHub issues GitHub pull requests

landingPage

πŸš€ Start your Open Source Journey! Contribute Today! 🀝

Table of Contents

What is GitOpener?

Git Opener is a beginner friendly open source project. This project serves as a guide to open source, with step by step information on how you can contribute. If you want to see your code in action, you're in the right place! πŸ’»

Learn Contributing πŸ“–

Everything you need to know to contribute to open source can be found here, from creating an issue to opening a pull request. Basic terminology can be found here! πŸ“š

guidesPage

Become Contributor πŸ‘₯

Contributors are featured on the web app. πŸ‘¨β€πŸ’»πŸ‘©β€πŸ’»

contributorsPage

How it works πŸ› οΈ

Based on your contribution file your-github-username.mdx, GitOpener will authenticate you.

profilePage profilePage2

How to create your profile πŸ“

Installation steps are featured here.

If you want to skip the installation and create your profile directly, head over to docs.

Check out the contribution guidelines before contributing.

Contribution guide 🀝

Installation 🚧

This is a Next.js project bootstrapped with create-next-app

  1. Fork the repo into your account 🍴 Fork Image
  2. Clone the project into your local machine πŸ–₯️
git clone https://github.com/<Your-GitHub-username>/gitopener.vercel.app.git
  1. Navigate the folder πŸ“‚
cd gitopener.vercel.app
  1. Install the dependencies πŸ“¦

    As Git Opener uses yarn package manager, it is recommended to use yarn, install yarn

yarn install
  1. Make .env.local file in root directory with these variables πŸ“

    This step is optional, Do this step if you want to run complete application with database support

MONGO_URI= 'YOUR MONGODB CONNECTION STRING GOES HERE'
GITHUB_TOKEN= 'YOUR GITHUB TOKEN GOES HERE'
  1. Run the project on local machine
yarn dev
  1. Every time you start making changes to your forked repo make sure it's in sync with the original repo

Contributing Guidelines πŸ“œ

Thank you for considering to contribute to this project.

What do I need to know to contribute? πŸ€”

This project is in a very early stage so anybody who's familiar with ReactJS/NextJS/Typescript/TailwindCSS can contribute. If you don't feel ready to make a contribution yet, no problem at all. You can also contribute to this README section or the Documentation part of our project. 😊

If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below. πŸ”

How to make a Contribution? πŸ€πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

Never made an open source contribution before? And wondering how to contribute to this project? πŸ˜• No worries! Here's a quick guide, πŸš€

  1. Choose any feature/bug you wish to contribute to. πŸŽ‰
  2. Fork the repository into your own account. 🍴
  3. Clone the repo you have forked in your local machine using git clone https://github.com/<Your-GitHub-username>/gitopener.vercel.app.git
  4. Create a new branch for your fix by using the command git checkout -b YourName-branch-name
  5. Make the changes you wish to do and stage them using the command git add files-you-have-changed or use git add .
  6. Use the command git commit -m "Short description of the changes" to describe the changes you have done with a message.
  7. Push the changes to your remote repository using git push origin your-branch-name
  8. Submit a PR(pull request) to the upstream repository pbclife/gitopener.vercel.app with a title and a small description. πŸ™
  9. Wait for the pull request to be reviewed by us. πŸ•°οΈ
  10. Make appropriate changes if the maintainer recommends you to and submit it. πŸ”„
  11. Await for your contribution to be merged into the repository. 🎊

Checkout the Contributing.md file before contributing. πŸ“–

πŸ“ License

View Project License

This project is licensed under the terms of the MIT license. The MIT license is a permissive free software license that allows you to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software. It is a simple and short license that is compatible with most open source licenses and is widely used in the open source community.

The MIT license includes a disclaimer of liability, meaning that the project's contributors cannot be held liable for any damages that may arise from the use of the software. It also requires that any copies or modifications of the software include the same license terms and copyright notice as the original software.

Thanks to all the Contributors ❀️

Your Support means a lot

Give a ⭐ to the project if you liked it. 😊

gitopener.vercel.app's People

Contributors

aadarsh805 avatar adityachatap15 avatar aniketns avatar ashwanthramkl avatar dependabot[bot] avatar lavanyayangala avatar mishba-ai avatar priyankarpal avatar ripeliz avatar sajjanyadav avatar sboy99 avatar shivam-amin avatar soumya-kushwaha avatar srivatsavsurya avatar suzy-g38 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

Watchers

 avatar

gitopener.vercel.app's Issues

Bug: 404 error (remove test profiles from the contributors page)

Is there any existing issue for this?

  • I have searched the existing issues

Description

After clicking the contributor's profile. It's showing a 404 error. I added a screen recording please check

Screenshots

2023-03-12_12-13-33.mp4

Any additional information?

I'm using Brave Browser

What browser are you seeing the problem on?

No response

Feat: Change Home Page

Description

The home page currently holds the documentation as a placeholder
that needs to be changed to more meaningful stuff about GitOpener

Screenshots

No response

Additional Information

No response

Feat: make a good github org

Description

hi maintainers. Kindly add some requirements such as adding GitHub org readme, support, banners etc.

  • it helps newcomers to add value
  • we can get more github contributors
  • Trust
  • best community

Now it's basic

Screenshots

image

Additional Information

No response

Feat: Update Readme

Description

Must have the introduction of GitOpener at the top
Use some screenshots

Screenshots

No response

Additional Information

No response

Feat: Add security policy

Description

Just add a security policy for the OSS project.

How to add?

click on the insights tab > then Community Standards > then click on propose In the security policy

image

Screenshots

image

Additional Information

No response

Refactor: Handle manual condition checks using `clsx`

What would you like to share or ask?

As clsx library has the same and better potentials to handle class names of tailwindcss so using clsx would be better than manual conditioning.

Additional information

Try to replace each and every component that uses className attribute as a condition.

Q: What is Github ?

Describe GitHub in your words,You can mention the basic functionalities of Github, Put a reason why Github.

Bug: Edit on github button is showing 404 not found

Is there any existing issue for this?

  • I have searched the existing issues

Description

Edit on Github button is not working on start contributing section. And showing 404 not found.

To reproduce
Go to
start contributing section of the web app
Click on
edit on github icon [+-]

Screenshots

No response

Any additional information?

Expected Behaviour
Redirect to github repository file with edit mode open

What browser are you seeing the problem on?

No response

feat: Dark Theme

Features

  • add loading bar
  • add theme context
  • add dark mode
  • modify all components according to theme

Feat: Structure Home Page and design.

Features Proposed

  • Mention how can an contributor set up that project in their machine?
  • Render Contribution Guideline
  • Render Contributors Section, display few contributors with a view all link that navigates to /contributors

Feat: Discover OpenSource projects section

Description

This section will list feature/popular and beginner level opensource projects

Screenshots

Desktop - 1 (3)

Additional Information

maybe we can also add specific issues to grab in beginners section

Feat: Enable heading referencing in guide page

Description

In Guide page section enable # referencing

  • Create a RefWrapper mdx component to wrap h2, h3 headings
  • Create a rehype plugin withRefLinks that grabs h2, h3 elements and wrap with RefWrapper mdx component
  • Design RefWrapper component so that on hover # sign pop ups and user can copy the link.

Screenshots

Screenshot from 2023-01-29 10-59-36

Additional Information

No response

Bug: On reload sidebar gets reset.

Is there any existing issue for this?

  • I have searched the existing issues

Description

Sidebar is automatically pointing to the welcome when page gets reloaded, that does not match the content.
To reproduce
Go to
start contributing section of the website change links to installation
then
reload the page

Screenshots

Screenshot from 2023-01-29 11-33-00

Any additional information?

Expected Behaviour
Links should be persistent with the page, for above example it should be pointing to installation instead of welcome after reload.

What browser are you seeing the problem on?

Chrome

Feat: add your contribution profile

- Description

  • Fork this repo.
  • Create a file inside the contribution folder.
  • Create a file that matches your github username with the .mdx extension (eg. your-github-username.mdx)
  • Add your contribution and create a pull request.

- Check the official guide: Add your profile

πŸ“Œ If you're facing any problem you can discuss your problem in the Discussion area.

bug: page is scrolled to top in active page

###Describe

  • Whenever a menu button is clicked in active page it is automatically scrolling to top.
  • Thats should not be the basic behaviour, it needs to be scrolled to the top when a route is changed not in current route

Feat: Add a custom rehype plugin that differentiates between external & internal links

Description

The issue is about creating a custom plugin that identifies internal and external type by string matching. Then it should wrap internal links with next Link component & for external links the link should open in a new tab.

Steps

  • Create a new file withNextLinks inside src/lib/mdx/rehype
  • Build an rehype plugin using visit function
  • Import the the plugin in getMdxComponents and enlist that plugin with rehypePlugins list

Screenshots

N/A

Additional Information

This feature will improve documentation experience. And will prevent unnecessary link opening and also will leverage the power of next Link component.

Q: Mention best practices while getting started with open source ?

You can mention what you do when you contribute to a open source project.

Some Practices I personally follow

  1. Create a branch with issue tag like -<feat / bug / other>- for example 31-docs-question
  2. Adding specific commit regarding changes applied
  3. Committing all changes to that branch
  4. Push to local repository
  5. Create a pull request by tagging resolvable issue number
  6. Added more commits to that branch if any changes are requested by the maintainers.

feat: CRUD for contributors

Describe

  • This feature implements CRUD for contributor
  • This feature will establish a connection with Database and will query according to the request.

Feat: add social links in contributor profile page

Description

Currently, social links are not working as they are not plugged in. Retrieve social links from contribution meta data and add as link component and render respective icon.

Screenshots

No response

Additional Information

No response

Feat: Change Repository Name

Description

I would like to inform you that you should change the repo name to GitOpener.
gitopener.vercel.app is the website name.

Screenshots

image

Additional Information

No response

Q: What is Git ?

Add a short note on Git in your words, Please make it specific and beginner-friendly

Q: What is pull request ?

You can write importance of pull request, why one should consider specific pull request while working with different changes.

feat: Design Footer

Description

  • Add Footer section
  • Add Links
  • Add a slogan
  • Add copyright
  • Design Footer

Feat: Add prev and next page section in start contributing section

Description

In this feature user should be able to navigate to next or previous page according to the next or previous file accordingly.

  • Create a component that accepts prev and next props which can be used for navigation
  • Enable page mapping, map prev and next page link based on current page return null if no prev of next page found
  • Align the component to the bottom of documentation layout
  • Design the component with responsiveness

Screenshots

No response

Additional Information

No response

Refactor: Optimise code base

Changes Proposed

  • Rename component files using React naming convention
  • Using FC component instead of simple function tag

Feat: Add GItHub actions

Description

I would like to say that please add GitHub actions such as greetings, build test, semver release, stale issue etc. These will help automate some works.

Screenshots

No response

Additional Information

No response

Feat: Add documents contributor profile in the bottom of each page in start contributing section

Description

This changes will be synced will database,
Create a Document contributors model with

------
---
{
slug:{
  type:String, // should be the page unique slug(params url)
  required:true
},
contributors:[
  {
   avatar:String,
   gh_username:String,
   github_url:String
  }
],
}
------
---

create API for fetching contributors from Github API and store it to database.
The fetching should occur once at build time.

Screenshots

N/a

Additional Information

N/A

Feat: Add mdx utility components

Description

Add mdx components to enhance mdx writing experience. These are the required components

  • Tip : For a tip message, should be green coloured
  • Warning : To display a warning message, should be yellow coloured
  • Info : To display some additional information, should match accent colour

Design those components and update allowed mdx components list

Screenshots

No response

Additional Information

No response

Feat: Contributors profile page

Description

Features

  • Create profile of each contributors,
  • Display their name and occupation as contributed in the .mdx file
  • Show their Github profile avatar and bio
  • Add Introduction, Skills, Socials section as of now
  • Build a Tab mdx component

Screenshots

No response

Additional Information

If you want to contribute to this, instead of creating pull request direct on main branch create on here

Bug: release workiflow is invalid

Is there any existing issue for this?

  • I have searched the existing issues

Description

After running release workflow its showing invalid

Screenshots

No response

Any additional information?

No response

What browser are you seeing the problem on?

No response

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.