Git Product home page Git Product logo

github-readme's Introduction

GitHub ReadMe Generator

GHReadMeReadMe-Slim

Table of Contents




Introduction

Introducing our latest product, the hassle-free and open-source GitHub Profile ReadMe customisation tool! With no login or registration required, you can quickly mix and match different components to create an impressive and informative GitHub Profile ReadMe page. Our drag and drop functionality makes the customisation a breeze, and with the tool being Open Source, you can expect new ideas and features to be added regularly. Try it out today and take your GitHub profile to the next level! πŸ’ͺ🏻

This project is exclusive to GirlScript Summer of Code and it’s assumed that you’re participating in it, so kindly don’t specify this if you’re raising an issue or a pull request. I’ll be definitely giving sarcastic responses, if you fail to follow this and don’t blame me! πŸ˜…

Motivation

As a software engineer, I understand the importance of having a well-organised and informative GitHub profile ReadMe page. It not only helps users understand the developer’s skills and experience but also showcases their creativity and attention to detail. However, with so many people creating different styles of ReadMe pages, it can be challenging to keep track of all the available components and customisation options. 🀯

That’s why I believe that creating a comprehensive guide to GitHub profile ReadMe customisation is a valuable project. By compiling all the available components and customisation options in one place, we can provide developers with a go-to resource for creating impressive and informative profile ReadMe pages. This project will not only help developers save time by not having to search for different options but also ensure that they don’t miss out on any essential components. πŸ₯Ή

As a software engineer, I am committed to creating user-focused software that meets the needs of the end-user. By providing a comprehensive guide to GitHub profile ReadMe customisation, we can help developers create intuitive and user-friendly interfaces that enhance the user experience. Additionally, I understand the importance of time management and quality assurance in software development. By thoroughly testing and ensuring that the guide is free of bugs and errors, we can deliver a high-quality resource that developers can rely on. πŸ‘ŒπŸ»

In summary, this project is motivated by the need to provide developers with a comprehensive guide to GitHub profile ReadMe customisation. By doing so, we can help developers save time, not miss out on any essential components, and create user-focused and high-quality profile ReadMe pages that showcase their skills and experience. πŸ’ͺ🏻

Product Features

Here's a list of all the features of our GitHub Profile ReadMe customisation tool:

  • πŸ”“ No login or registration required.
  • πŸš€ Hassle-free and easy to use.
  • 🎨 Mix and match different components to create a customised profile ReadMe page.
  • πŸ–±οΈ Drag and drop functionality for easy customisation.
  • 🌐 Open source, allowing for new ideas and features to be added regularly.
  • πŸ“š Comprehensive guide to GitHub profile ReadMe customisation.
  • πŸ‘₯ User-focused software that enhances the user experience.
  • πŸ› Thoroughly tested and free of bugs and errors, I hope! πŸ˜…
  • ⏰ Saves time by providing all available components and customisation options in one place.
  • πŸ’ͺ🏻 Helps developers create high-quality and informative GitHub Profile ReadMe pages that showcase their skills and experience.

With our GitHub profile ReadMe customisation tool, you can take your GitHub profile to the next level and impress potential employers and collaborators. Try it out today and see the difference it can make! πŸ€—

⬆️ Back to Top

Development

System Requirements

Here’s a recommended guide, but if you want to know what exactly I use, feel free to check out My Personal Development Environment and clone it for yourself. πŸ’»

  • Operating System: Windows / Mac / Linux
  • Version Control: Git
  • Browser: Google Chrome + React Developer Tools
  • Run Time: Node JS 18.16.0 LTS
  • IDE: Microsoft Visual Studio Code

Installation & Running Instructions

First step is to β€œFork” the project under your name and keep the main branch always sync’d with this repository to ensure there are no issues with your Pull Request like those dreaded Merge Conflicts! 😈

  1. Clone the Repository (your fork) and make sure it’s in the latest main branch.
  2. If you think it might be stale, issue a git pull so that it’s up to date.
  3. If you’re running for the first time, install the dependencies by running npm ci (or if you’re not lazy, run npm clean-install).
  4. Once the installation is over, start the app locally by running npm start.
  5. Hope everything works, check by opening http://localhost:3000/ on your browser (it might have already started your browser, kindly check).

Here are all the commands...

$ git clone https://github.com/<Your-GitHub-Username>/GitHub-ReadMe.git
$ npm ci
$ npm start

If npm ci gives issues on Windows or Linux machines, please use npm i (or if you’re not lazy, run npm install).

If you’re facing any issues, feel free to message me on WhatsApp / LinkedIn / Twitter / Discord / Email (on the order of responsivenes, email being the slowest)! πŸ˜…

ScreenCast

(TODO: Video of a user doing the installation!)

⬆️ Back to Top

Contribution Guidelines

Quick Steps to Contribute

There are two ways to contribute to this project.

  1. Landing Page: Very basic HTML, CSS and JavaScript Static Website.
  2. Web App: Again another beginner friendly React JS App that uses Node SASS for SCSS and React Router v6.

Here are some quick and simple instructions, which no one can mess up! πŸ’ͺ🏻

  1. Fork & Star the Repo and don’t forget to Subscribe to my YouTube Channel for Updates on this! πŸ’ͺ🏻
  2. Get connected with Praveen Kumar so that you can have a quick discussion regarding new features or issues! πŸ›
  3. Read through the instructions to set it up locally. πŸ’»
    1. Make sure you have configured your environment properly before installation.
    2. Install all the dependencies and issue the start command.
  4. Run the project and explore every bit of the project. Here’s a walkthrough video! πŸ“Ί
  5. Understand the already raised - accepted issues to start work with. πŸ€”
    1. If the issue is already assigned to someone else, please enter your comment but look through and try to see how you can fit.
    2. If it’s not already assigned, tell how you can solve this issue, explain your procedure in your mind and ask to assign.
  6. If you can’t find any issues, identify potential bugs or improvements for the project! πŸ”Ž
  7. Once you’ve been assigned the issue, kindly follow the Contributing Guidelines and make a Pull Request! 🀝🏻
  8. I’ll go through your PR and if it’s of good quality, congrats, thanks for your contribution. 😁
  9. Occasionally, if there are some issues, I’ll definitely point them out and I won’t close the PRs without a valid info! πŸ₯Ή

Multiple Branches

Note that there are totally three branches initially. πŸƒ

  • main - Has the Source Code of the React App.
  • gh-pages - The React App is deployed in this branch.
  • website - The Landing Page source code is in this branch, will be using an alternate deployment method using Cloudflare Pages.

In doubt, please ask a question! πŸ’ͺ🏻

GirlScript Summer of Code

This repository is dedicated to GSSoC ’23, so kindly don’t add anything like β€œas a part of GSSoC” on the issues.

Labels & Points Guidance

The whole pointing system in GSSoC ’23 is automated, so there’s no manual entry of creating any sheets or anything! πŸ’ͺ🏻

Note: The below has not been verified yet. Please wait till the official points are out.

Label Name Difficulty Points
easy Easy 10
medium Medium 25
hard Hard 45

Mentors

Note: The below list is subject to change due to an ongoing confusion. Please wait till this message is removed.

Name GitHub Twitter LinkedIn Email
Ashwin Kumar R GitHub: @Ash515 Ashwin Kumar Ramaswamy βœ‰οΈ
Rose Kamal Love GitHub: @rosekamallove Rose Kamal Love βœ‰οΈ
Anoop Kumar Singh GitHub: @anoopsingh1996 Anoop Singh βœ‰οΈ
Rachit Agarwal GitHub: @rachitag112 Rachit Agarwal βœ‰οΈ

Project Admin

Praveen Kumar Purushothaman
Praveen Kumar Purushothaman
PositionFull Stack JavaScript Specialist
LinkedInPraveen Kumar Purushothaman
TwitterPraveen Kumar Purushothaman
GitHubPraveen Kumar Purushothaman
YouTubePraveen Kumar Purushothaman

⬆️ Back to Top

Demos

(TODO: Image of the GitHub ReadMe Generator, keep this dynamically updated every time the app is updated)

Live Demo

If you want to try out the application, check out the Production App here. 😁

App Screen

Also we have a marketing page, check out the Landing Page as well! πŸ€—

Home Screen

Video Demo

For the chilled out folks, I have created a couple of videos here for both the landing page for marketing this app and the hosted app itself! 😁

Landing Page

(TODO: Add the video...)

Hosted App

(TODO: Add the video...)

⬆️ Back to Top

Contributors



Thank you to all the amazing contributors who have made this project possible! πŸ’ͺ🏻

Show some ❀️ by starring this awesome repository! 🌟

⬆️ Back to Top

Resources

YouTube Videos

All the YouTube Videos that are related to this project are listed in chronological order.

  1. Intro to Cats in Tech GitHub ReadMe
  2. Cats in Tech GitHub ReadMe Project Information (Trailer)
  3. Cats in Tech GitHub ReadMe Project Information
  4. Steps to Start with Open Source through GSSoC ’23 (WIP)
  5. How to get the best out of GSSoC ’23 (WIP)
  6. Contribution Instructions for First Timers (WIP)

⬆️ Back to Top

github-readme's People

Contributors

amanjain18 avatar gurjeetsinghvirdee avatar isha988 avatar mukul314 avatar praveenscience avatar rohanmittal1163 avatar swastik007sharma avatar tayyab-ilyas 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

Watchers

 avatar  avatar  avatar  avatar

github-readme's Issues

Adda background and drop down option

The current navbar lacks a background and a dropdown option, which affects the visual appeal and user experience of the website. This issue aims to address these missing features and enhance the navbar's functionality.

Proposed Solution
Add a background to the navbar to provide visual distinction and improve readability.

Implement a dropdown option that shows a menu when clicked. The menu should include the following options: Home, Bookmark, and About.

Expected Behavior
The navbar should have a visually appealing background that complements the overall design of the website.

When the user clicks on the dropdown option, a menu should appear with the options: Home, Bookmark, and About. Clicking on any of these options should perform the corresponding action or navigate to the respective page.

Adding Carousel to Slider in "Show Our Apps Screenshots"

I think it would be better to have Carousel slider on "Show Our Apps Screenshots" as it makes it more interactive rather than waiting for it to slide. And also if the number of slides increases than it will take a bit of time to go through it.

Update `git clone` Command in `README.md` Installation Instructions

The current git clone command provided in the Installation & Running Instructions section of the README.md file is incorrect and needs to be updated.

The existing command suggests using a generic URL for cloning the repository, which may cause confusion for users trying to follow the installation instructions. To ensure clarity and accuracy, it is recommended to replace the current command with the following:

git clone https://github.com/<Your-GitHub-Username>/GitHub-ReadMe.git

This updated command provides a specific URL that users can customize by replacing <Your-GitHub-Username> with their actual GitHub username. By making this change, it will help users correctly clone the repository and proceed with the installation process without encountering any unnecessary difficulties.

🐞 [BUG_LP] - App screenshots do not fit exactly in the mobile frame

Description

Apps screenshots do not fit exactly inside the mobile frame under the Show Our App Screenshots section.

Current Behaviour

The images do not fit the mobile frame thus hiding data.

Expected Behaviour

The images should fit the mobile frame without hiding any data so that it looks as if they are inside a real phone.

Reproduction Steps

No response

Screenshots

image

Additional information

Can you assign me with this issue?

Contributor terms

  • I agree to follow the Contributing Instructions

πŸš€ [New Feature_LP] - Add SignIn page

Description of the enhancement. ✍🏻

I would like to add the signin page for the website.
so , please assign this to me under GSSOC'23.

Describe briefly how you would implement this enhancement.

I would like to add the signin page with the data validation.

Screenshots Example (if applicable)

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

πŸš€ [New Feature_LP] - Transform scale effect on social buttons

Description of the enhancement. ✍🏻

Hey, @ I want to add a hover effect on social buttons using transform property. On hovering its defines a transformation that resizes social buttons on the 2D plane. Please assign me this issue. Thank you!

Describe briefly how you would implement this enhancement.

Some steps to implement this enhancement-
1. Add Transform scale effect
2. Step 2
3. Step 3

Screenshots Example (if applicable)

Before:

before.mp4

After:

after.mp4

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

Add Code of Conduct to the Repository

It is essential to foster a welcoming and inclusive environment for all contributors and maintain a respectful community within the project. To ensure this, it is recommended to add a Code of Conduct to the repository.

A Code of Conduct outlines the expected behavior and sets clear guidelines for all participants involved in the project. It helps create a safe and harassment-free space, promoting constructive discussions and collaboration.

I suggest incorporating a Code of Conduct file, such as CODE_OF_CONDUCT.md, in the root directory of the repository. This file should include the following:

1. A statement emphasizing the commitment to fostering an inclusive and respectful environment for all contributors.
2. Clear guidelines on expected behavior, including examples of unacceptable behavior.
3. Instructions for reporting any violations of the Code of Conduct.
4. Information on how reports will be addressed and any consequences for violations.
5. Contact details for individuals who can address Code of Conduct issues or concerns.

By including a Code of Conduct, we establish a strong foundation for a positive and inclusive community. It will provide contributors with a reference point for appropriate conduct, as well as ensure that any potential issues are addressed promptly and effectively.

Note Here's a sample CODE_OF_CONDUCT.md

cc/ @praveenscience

Bug: Add map to direction button in contact section

This commit addresses the bug reported in Issue [GSSoC'23]. Previously, the direction button in the contact section of the website was not linked to a map, making it difficult for users to find the location. The issue has been resolved by adding a map to the direction button, providing users with a convenient way to access directions.

To fix this bug, the necessary changes have been made to the codebase. The direction button now includes an embedded map that displays the location of the contact address. When users click on the button, they will be directed to the map with a pin marking the exact location. This enhancement improves the user experience and enables visitors to easily navigate to the desired destination.

To ensure the functionality and accuracy of the embedded map, it has been tested on multiple devices and browsers. The map's responsiveness and usability have been verified to guarantee a seamless experience for all users.

Please review and merge this commit to resolve the bug and enhance the contact section of the website by adding a map to the direction button.

screencapture-githubreadme-co-project-details-html-2023-05-27-12_33_49

Bug: Fix social media link clickability in footer

This commit addresses the bug reported in Issue [GSSoC'23]. Previously, the social media links in the footer were not clickable, rendering them non-functional. The issue has been resolved by implementing a fix that enables users to click on the social media links and be redirected to the respective social media profiles.

The bug was caused by missing anchor tags or incorrect HTML attributes in the footer section of the website. Upon investigation, it was found that the necessary anchor tags were not present or the href attributes were incorrect, resulting in the links being unclickable.

To fix this, the HTML markup in the footer has been modified to include proper anchor tags with correct href attributes. Additionally, relevant CSS styles have been adjusted to ensure the links are visually distinguishable and appear clickable to users.

This fix has been thoroughly tested on different devices and browsers to ensure cross-compatibility. Users should now be able to easily access and navigate to the social media profiles linked in the website footer.

Please review and merge this commit to resolve the bug and restore the functionality of the social media links in the footer.

screencapture-githubreadme-co-project-details-html-2023-05-27-12_33_49

🐞 [BUG_LP] - Adding Team Page in the Website

Description of the bug. ✍🏻

In Navigation bar there is a button named pages with a option of teams but the teams button is redirecting to the landing page only. I wish to add a team page for that button.

Current Behaviour

The team button is redirecting to home page only .
image

Expected Behaviour

The team button should redirect to a page having info about team.

Reproduction Steps

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Screenshots

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

Update `CONTRIBUTING.md` to Reflect Relevant Details/Links of GitHub-ReadMe Repository

The current CONTRIBUTING.md file in the GitHub-ReadMe repository appears to be a direct copy of the CONTRIBUTING.md file from the CatsInTech/Rezume repository. This results in inaccurate and irrelevant information for contributors.

Screenshot 2023-05-29 at 1 28 41 AM

To maintain consistency and provide accurate guidelines for potential contributors, it is recommended to update the CONTRIBUTING.md file of the GitHub-ReadMe repository to reflect the necessary details and links specific to that repository. This would help ensure that contributors have the correct information and resources to make meaningful contributions to the project.

Enhancing Website Animation on GitHub Readme

The current GitHub Readme website lacks animation, resulting in a static and less engaging user experience. To improve the overall aesthetics and user interaction, I propose to add animations throughout the website. This includes implementing smooth features such as slide-ins, component movements, and dynamic transitions when entering or navigating the page.

Proposed Solution:
The proposed solution is to incorporate animations that enhance the visual appeal and interactivity of the GitHub Readme website. This can be achieved by utilizing CSS animations, JavaScript libraries, or frameworks to create smooth transitions and captivating effects. The suggested animations include slide-in effects for sections or elements, subtle movements of components, and dynamic transitions triggered when the page is entered or certain interactions occur.

Benefits

  1. Enhanced User Experience
  2. Improved Aesthetics
  3. Increased Engagement

πŸš€ [New Feature_LP] - Hover effect on social buttons

Description of the enhancement. ✍🏻

Hey, @praveenscience I want to add a hover effect on social buttons. On hovering its color changes to the respective official color of social media. Please assign me this issue. Thank you!

Describe briefly how you would implement this enhancement.

Some steps to implement this enhancement-
1. Add hover effect
2. Step 2
3. Step 3

Screenshots Example (if applicable)

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

Video of a user doing the installation

In order to make installation hassle-free. We need to add a quick guide video to explain the installation process.

I would like to work on this issue.

Enhance the UI of contact us page

Hello @praveenscience ,
I would like to enhance the frontend design of contact us page which will help the user to contact or share their experience with the owner of the website easily. This will help to enhance the user experience.
The page will have a form which collects necessary details like email address, mobile number, message, company name etc.
Please assign me this issue.
I would like to work on this issue under GSSOC'23.

Create PR Templates

As a part of GSSoC 23, I would like someone to create a PR Template that takes up following options.

  1. New Feature (Landing Page)
  2. New Feature (App)
  3. Bug (Landing Page)
  4. Bug (App)
  5. New Component (App)
  6. Your Idea for Level (GSSoC)
  7. Which Issue it Solves?

And it should automatically give the default GSSoC Label. Please explain how you're planning to do it while you wanna grab this issue.

Glitch in Navbar in mobile view

The hamburger icon in the navbar(mobile view) does not change to the close button on click. I want to fix this glitch.

Plz, assign this task to me.

πŸš€ [Refactor_WebApp] - Change the router

Description of the enhancement. ✍🏻

We can change the router to RouterProvider instead of BrowserRouter this will allow us to use the data APIs like loaders and actions. What do you think πŸ€”

Describe briefly how you would implement this enhancement.

By importing the required functions and components.

Screenshots Example (if applicable)

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

Add "Back to top" button in ReadMe.md

Could we add a 'Back to Top' button for contributors' convenience? It would allow users to easily navigate back to the top with a single click. Also, I'd be happy to take on this issue if assigned. Thank you!

πŸš€ [New Feature_LP] -SignUP page

Description of the enhancement. ✍🏻

I would like to add the signup page for the website .
So , please assign this to me under GSSOC'23.

Describe briefly how you would implement this enhancement.

...

Screenshots Example (if applicable)

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

πŸš€ [New Feature_WebApp] - Add design to the title and enhance the navbar by adding better color and other properties.

Description of the enhancement. ✍🏻

Hi @praveenscience , I am Arun.I am planning to work on the production page which currently has some documentation.I would like to first design the navbar and the title with those fonts and colors you have used in ur landing page.

Describe briefly how you would implement this enhancement.

Some steps to implement this enhancement-
1. Add a better font and color to the title
2. Enhance the navbar section.

Screenshots Example (if applicable)

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

πŸš€ [New Feature_LP] - Hover effect on navbar

Description of the enhancement. ✍🏻

Currently, when we hover over the navbar only the opacity of the links changes, this is not that attractive.

Describe briefly how you would implement this enhancement.

Some steps to implement this enhancement-
1. Instead, we can add hover and transition effects on the links to make them more attractive

Screenshots Example (if applicable)

Look at the below videos for more context :

Before :

bandicam.2023-06-01.10-25-08-051.mp4

After :

bandicam.2023-06-01.10-24-16-574.mp4

Additional information

@praveenscience , I'd like to work on this issue.

Contributor terms

  • I agree to follow the Contributing Instructions

Video is blurry

Hey @praveenscience the video on the home page is not properly visible. I want to add a video. Please assign me this issue. Thank you!

[feature] add license

hi @praveenscience seems like your github repo does not include license file.
I know the procedure to add license file and what to add in it. MIT would be suitable to it
pls assign me this issue under the ongoing open source contribution
thank you

πŸš€ [New Feature_LP] - Accessible Social Anchors on Footer

Description of the enhancement. ✍🏻

  • This enhancement is about adding aria-label for social anchors (links like Github) which are placed inside the footer element

  • it is important to note that we want to add the title attribute also. This is because the title attribute is intended to provide additional information to screen reader users.

  • The aria-label attribute is a way more important for providing accessibility information to screen reader users. The aria-label attribute is an Accessible Rich Internet Applications (ARIA) attribute that can be used to provide a label for an element. This label is then read aloud by screen readers, providing additional information about the element to the user.

  • In general, the aria-label & title attributes are preferred for providing accessibility information to screen reader users.

  • You can consider to assign this issue to me to make the site accessible for screen readers

Describe briefly how you would implement this enhancement.

Some steps to implement this enhancement-
1. Step 1: Add `aria-label` for all social anchors
2. Step 2: Add `title` for all anchors (normal `a` elements)
3. Step 3: Check if the site is accessible, If yes then commit πŸš€

Contributor terms

  • I agree to follow the Contributing Instructions

Add Auto Comment Feature to Improve Collaboration

Issue Description:
As an active contributor to your open-source project, I believe that implementing an auto-comment feature would greatly enhance collaboration and communication within the project. This feature would automatically generate comments in response to specific events, such as when an issue is opened, a pull request is created, an issue is assigned, or an issue is unassigned.

Feature Details:

  • When an issue is opened, the auto-comment should greet the author and provide a brief acknowledgement and request for additional context.
  • When a pull request is opened, the auto-comment should greet the author, express gratitude, and remind them to follow the project's contributing guidelines.
  • When an issue is closed, the auto-comment should thank the author for their contribution and encourage further engagement.
  • When an issue is assigned to someone, the auto-comment should notify the assignee and encourage them to start working on it.
  • When an issue is unassigned from someone, the auto-comment should notify the assignee about the change and suggest reassignment if they are offline.

Benefits:

  • Improved communication and engagement with contributors.
  • Provides clear instructions and acknowledgements for various events.
  • Enhances collaboration by setting expectations and providing reminders.
  • Reduces manual effort by automating comment generation.

Acceptance Criteria:

  • The auto-comment feature should be implemented using the "wow-actions/auto-comment" GitHub Action.
  • Comments should be appropriately customized for each event, mentioning relevant parties and providing the necessary information.
  • The auto-comment workflow should trigger on the following events: issues opened, pull requests opened, issues closed, issues assigned, and issues unassigned.
  • The feature should be added to the project's existing GitHub Actions workflow file.

Additional Context:
Feel free to ask any questions or seek clarification regarding the auto-comment feature. I'm excited about contributing to your project and believe this enhancement will greatly benefit its community.

Change certain fonts and alingment

The UI needs to be given more importance to for any readme file
I think the fonts of headings and content needs to be different and the alignment as of the project admin needs to be in the centre.

🐞 [BUG_LP] - Link Our Partner with Trusted Companies

Description of the bug. ✍🏻

In navbar there is a dropdown named pages having our partner button which is redirecting to home page only. So I think that it should be linked with the Trusted companies section of the main page

Current Behaviour

Our Partner button redirecting to home page.

Expected Behaviour

Our Partner button should redirect to Trusted Companies section in the main page

Reproduction Steps

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Screenshots

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

Add FAQ answer for the question: Which license do I need?

Here is the Answer of first FAQ

Which license do I need?
Which license you need depends on the specific use case and the type of content you want to license. Here are some common license types and their typical applications:

  1. Creative Commons (CC) licenses: If you want to share your work with others and allow them to use, distribute, or modify it under certain conditions, Creative Commons licenses are a popular choice. There are several types of CC licenses, ranging from more permissive to more restrictive.
  2. Open-source licenses: If you are sharing software or code, open-source licenses govern the terms under which others can use, modify, and distribute your code. Popular open-source licenses include the MIT License, GNU General Public License (GPL), and Apache License.
  3. Commercial licenses: If you want to monetize your work and restrict others from using it without permission, you may choose a commercial license. These licenses typically require individuals or organizations to purchase a license to use your content for commercial purposes.
  4. Public domain dedication: If you want to release your work into the public domain, where anyone can use it without restrictions, you can choose to dedicate it to the public domain. Keep in mind that public domain laws vary by jurisdiction.
  5. Custom licenses: In some cases, you may want to create a custom license with specific terms and conditions tailored to your needs. Custom licenses can offer more flexibility but may require legal expertise to draft and enforce.

It's important to carefully consider your goals, the intended audience, and the level of control you desire over your work when choosing a license. You may also want to consult with a legal professional to ensure your chosen license aligns with your intentions and provides the necessary legal protection.

@praveenscience Please assign this issue to me under gssoc'23

redirect button

adding a redirect button will help us reach the start of web page.
assign this issue to me

Create an Issue Template

As a part of GSSoC 23, I would like someone to create an Issue Template that gives the following choices.

  1. New Feature (Landing Page)
  2. New Feature (App)
  3. Bug (Landing Page)
  4. Bug (App)
  5. New Component (App)

And it should automatically give the default GSSoC Label. Please explain how you're planning to do it while you wanna grab this issue.

πŸš€ [New Feature_WebApp] - Setup Linting

Description of the enhancement. ✍🏻

We can setup linting so that the code is well-organized and readable. Also, this will help us to maintain the code style throughout the codebase.

Describe briefly how you would implement this enhancement.

This can be achieved using prettier, husky and eslint.

Screenshots Example (if applicable)

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

πŸš€ [New Feature_LP] - Enhance UI of the testimonial section

Description of the enhancement. ✍🏻

I would likes to change the ui of the
Screenshot 2023-05-31 154027
testimonial section to make it more attractive .

Describe briefly how you would implement this enhancement.

I would like to add box shadow and hover effects to make it more attractive.

Screenshots Example (if applicable)

No response

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

Use `README.md` / `CONTRIBUTING.md` / `CODE_OF_CONDUCT.md`

Discussed in #37

Originally posted by vinitshahdeo May 28, 2023
Let's use README.md / CONTRIBUTING.md / CODE_OF_CONDUCT.md in GitHub repositories.

  • On GitHub, the commonly used and recognized convention for the filename of the README file is "README.md". This is case-sensitive, so it should be written in uppercase for "README" and lowercase for ".md" (Markdown file extension). Using "README.md" as the filename ensures compatibility and consistency across different repositories and platforms. It is also the default filename that GitHub recognizes and displays prominently on the repository's main page. While some platforms may accept alternative filename variations like "Readme.md" or "readme.md", it is generally recommended to follow the "README.md" convention for better consistency and compatibility within the GitHub ecosystem.

  • On GitHub, the convention for the filename of the contributing guidelines file is typically "CONTRIBUTING.md". This convention is widely recognized and followed by many open-source projects and repositories. By using "CONTRIBUTING.md" as the filename, you ensure consistency and compatibility with other repositories and projects on GitHub. This naming convention is also recognized by various tools and integrations that rely on standard file naming conventions for contributing guidelines.

  • GitHub recognizes "CODE_OF_CONDUCT.md" as the default filename for the Code of Conduct file. Using this convention ensures consistency and compatibility with other repositories and projects on the platform. It also aligns with the expectations of various tools and integrations that rely on standard file naming conventions for Code of Conduct files.

@praveenscience wdyt?

🐞 [BUG_LP] - Removing dropdown from home button

Description of the bug. ✍🏻

In home button of navigation bar there is a drop down with several options named Home 1, Home 2,..... . And they are redirecting to home only . I believe that there is no need of the drop down, so with to remove the dropdown from home button.

Current Behaviour

Currently home button is having a drop down with several options redirecting to home page only

Expected Behaviour

Home button will not have any dropdown option

Reproduction Steps

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Screenshots

Screenshot 2023-05-31 at 2 12 25 PM

Additional information

No response

Contributor terms

  • I agree to follow the Contributing Instructions

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.