punyakrit/social-share

ShareHub is a Project where users can create their public viewable profile containing their customizable social links and important links that they want to share with the world. Also having option to see their page Analytics

ShareHub

Table of Contents

• Code of Conduct
• Contributing
• Setting Up Locally
• Connecting to MongoDB
• Creating Google Credentials
• Running the Development Server
• Learn More
• License
• Open Source Programs
• Acknowledgements
• Contributors

Code of Conduct

Please read our CODE OF CONDUCT for detailed guidelines.

How to Contribute?

We welcome contributions from anyone who is interested in improving this project. If you'd like to contribute, here are some ways you can get started:

Submit a bug report if you find any issues with the application. Suggest new features or improvements. Submit a pull request to fix a bug or add a feature. To submit a pull request, please follow these steps:

1. Fork this repository.

2. Clone the forked repository.

git clone https://github.com/punyakrit/social-share.git

3. Navigate to the project directory.

cd social-share

4. Add a refernce(remote) to the original repository.

git remote add upstream https://github.com/punyakrit/social-share.git

5. Check remotes for this repository.

git remote -v

6. Always take a pull from the main upstream repository.

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Make changes to the code base.

9. Stage your changes.

git add -A

10. Commit your changes.

git commit -m "relevant message"

11. Push your local commits to the remote repo.

git push -u origin <your_branch_name>

12. Create a pull request from your branch to the original repository.

Congratulations! 🎉 you've made your contribution.

Contributing

If you would like to contribute to the project, please follow our CONTRIBUTING guidelines.

FOLLOW THESE STEPS TO SET LOCALLY

1. Fork the repository (Click the Fork button in the top right on Github)
2. Clone the forked repository to your local machine.

git clone https://github.com/punyakrit/social-share.git

Run the command to install npm package

npm install

STEPS TO CONNECT WITH THE MONGODB

cp .env.example .env

Update all these env variables
GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET
NEXTAUTH_URL
NEXTAUTH_SECRET
MONGODB_URI
BUCKET
S3_ACCESS_KEY
S3_SECRET_ACCESS_KEY

Steps to create your own google credentials

https://console.cloud.google.com/

Create a new project and name it

Select the project

By click external, Add email and project name click on next

Add data as same as in the given image

Save and Copy the GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET

Add these data as same as it is given inside .env file

NEXTAUTH_URL

 http://localhost:3000

NEXTAUTH_SECRET

test

Commands to run the development server:

# Using npm

npm run dev

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

License

This project is licensed under License

Learn More

To learn more about the project, check out our Learn More page.

Open Source Programs

This project is a part of GirlScript Summer of code. We welcome contibutions from the community to help improve the project social-share.

Acknowledgement

We would like to express our gratitude to the following contributors for their valuable contributions to Social Share

Contributors

Developed with ❤️ by The Social Share Team

(Back to top)

social-share's Issues

Add Sign-In Button for Existing Users

Currently, there is a "Register" button, but no "Sign In" button for existing users. Please add a "Sign In" button to allow existing users to quickly access the sign-in functionality.

Login Page

Hey, As a GSSOC contributor I would like to contribute in the given project. I can create a Login and Signup page for you.

Automation for Autocommenting on PRs and Issues

• Autocomment on Issue Creation
• Autocomment on PR Raised
• Autocomment on PR Merged
• Autocomment on Issue Closed

[Feat]: Implement Auto Commenting feature for PR Merged

This feature aims to solve the problem of inconsistent and delayed communication following the merging of PRs. By automating the commenting process, it ensures that contributors receive timely feedback and acknowledgments. It also reduces the administrative burden on maintainers, allowing them to focus more on code reviews and other critical tasks.

Add Footer in the landing page

I would like to create footer for the landing page. As a Gssoc contributor, I would like you to assign this issue to me

Navbar is not responsive

Issue Description

The Navbar lacks interactivity and is not responsive for smaller and medium sized devices

Solutions

Responsive Navbar with proper hover effects and interactivity

Screenshots to fix

Program

Gssoc 24

Missing About Us Page, Contact us form and explore page

Issue Description

Currently there is no about us page, contact us form and explore page for the website. The navbar buttons are non functional

Solution

A proper, responsive and dedicated About Us Page, Contact Us form and explore page matching the websites purpose and theme color

Functional Navbar Links

Status

Urgent

Program

Gssoc 24

hover problem in footer.

When we hover on the github , linkedn and twitter icon, it is not visible . kindly see this in the screenshot given below .

image before hovering on any icon:

image after hovering on linkedin icon:

@punyakrit I would like to work on this issue under gssoc . kindly assign this issue to me . this issue is not going to take much time.

Add User Analytics and Graphs to Dashboard

Description:

• Display numbers showing how many users visited in the last day, month, and year.
• Include a graph to visually represent user analytics over time.

[UI] : Hover effects on navbar links

Description -> As of now the navbar are static text without any effects or links

Image ->

Note -> I am a contributor under GSSoC, please do label this issue accordingly

Workflows for closing Old PRs and Issues

• Workflow for closing old Issues
• Workflow for closing old PRs

Creating an About Page

I will create an About page for the website .

[FEAT]: Adding Contact Us page

There is no contact us page/ section available.

Please assign it to me under gssoc24 so that I can work on it.

Readme update

Redesign the readme file

Replace "Join for Free" with "View My Dashboard" for Logged-In Users

• Replace "Join for Free" with "View My Dashboard" when users are logged in.
• Additionally, the input box should be replaced with the user's username.

This will enhance the user experience by providing appropriate options for logged-in users.

[UI] : Change title name to "ShareHub"

Description -> The current web title is the default "Create Next App" instead of "ShareHub"

Image ->

Adding hover effect on buttons like register and join for free.

we can add a nice hover effect on the two buttons and also on the things listed in the navbar like contack , explore for better look. It will look good and add a nice touch to the website.

@punyakrit I would rely like to work on this issue under gssoc level1.
kindly assign this issue to me.

thank you.

Adding hamburger for mobile devices .

I will add the hamburger menu for make it more responsive navbar .

About page

When i am clicking an about link on navbar then nothing happens so i am not sure is about page is already created or not but if not i will create an about page or if already created so i will fix this bug .

Creating an bottom to top scroll button

I will create an bottom to top scroll button this will help the user to more from bottom to the top of the page .

Missing Learn.md file

Add Learn.md file as instructed by Gssoc guidelines

[Feat]: Implement Workflow for closing Old PRs

This feature aims to automate the management of open PRs in a repository, ensuring that outdated or abandoned PRs are closed in a timely manner. By doing so, it helps maintain repository hygiene, improves workflow efficiency, and provides a better experience for both maintainers and contributors.

[Feat]: Implement Auto Commenting Feat for Issue Creation

This feature aims to address the problem of delayed and inconsistent communication following the creation of issues. By automatically commenting on issues as soon as they are created, it ensures that contributors receive immediate feedback and acknowledgment for their efforts. This fosters a positive and supportive environment for collaboration, encouraging continued participation and engagement from contributors.

Add scroll effect for the Smooth Scroll in the landing page.

Update README with Additional Sections and Information

Enhance the README by adding and expanding the following sections:

• About: Provide an overview of the project.
• Getting Started: Include a step-by-step guide for new users, considering a video demo.
• Contributing: Expand this section with detailed instructions on how to contribute.
• File Structure: Detail the project's file structure.
• Roadmap: Outline future plans and features for the project.
• FAQ: Answer frequently asked questions.
• License: Include license information.

Design and Code Register Page Frontend

A redesigned register page is needed to provide a more user-friendly and flexible registration experience.

Request:
Please assign this issue to me. I will design and implement a new register page frontend .

[Feat]: Implement Auto Commenting when an Issue is Closed

This feature aims to solve the problem of poor communication and lack of acknowledgment when issues are closed. By automatically commenting on closed issues, it ensures that contributors are informed about the closure and are thanked for their efforts. This helps maintain a positive and engaging community atmosphere, encouraging continued contributions and fostering good relationships between maintainers and contributors.

Add Code of Conduct.md

Hey @punyakrit ,
It is important for our community to have a clear and concise code of conduct to ensure a welcoming and inclusive environment for all contributors. A Code of Conduct sets the expectation for behavior and outlines the steps for reporting and addressing unacceptable behavior. This can greatly enhance the community experience and maintain a respectful and collaborative atmosphere.
I want to add Code_of_conduct.md, please assign me this issue.

Add Contribution.md

Hey @punyakrit ,
To streamline the contribution process and make it easier for new contributors to get involved, it's important to have clear and detailed contribution guidelines. A CONTRIBUTING.md file outlines the steps and best practices for contributing to the project, ensuring consistency and high-quality contributions.
Please assign me this issue

contact page Design

Hey @punyakrit ,
contact page is missing ,i can create design with functionality

Image change option is not working

When I am trying to change the image and color it is not allowing me to change it. Kindly assign this issue to me

Adding dashboard buttons once the user has logged in and some more.

• There is no way to get to the dashboard for logged in users at this point.

• The cursor is small in comparison to the text it should have the same height.

• The X logo looks like a cross.

authentication

user should have to two choice for authentication third party like google ,github,...and second is email password

@punyakrit

[BUG] : All navigation links are dummy.

@punyakrit

check this out

all nav linkes are just text
instead we redirect user to /about, /explore pages

[Feat]: Implement Auto Commenting feature for PR Raised

This feature aims to address the problem of delayed and inconsistent communication following the raising of PRs. By automatically commenting on PRs as soon as they are raised, it ensures that contributors receive immediate feedback and acknowledgment for their efforts. This fosters a positive and supportive environment for collaboration, encouraging continued participation and engagement from contributors.

[Page Creation] : Creation of "Terms & Conditions"

As of now this page just contains the heading, we can write professional T&C and can make responsive for small and medium sized devices as well

Responsiveness of the website

I will create a fully responsive website as for some screen sizes it is behaving unexpected and also add hamburger menu .

Enhance Dashboard to Include User Settings and Sharing Options

• Expand the current dashboard to include settings for changing the username and full name.
• Add options to edit additional details, such as social links.
• Implement a 'Share Your URL' button to facilitate sharing with other users.

These enhancements will provide users with greater control over their profile and make it easier to share their information.

Hero Section text animation

Sending username from landing page to onboarding screen

User writing their username in a landing page is not being sent to the onboarding screen
Requires fix

Globe animation

Adding globe animation in home

[UI] : Footer social media links do not lead to any page

Description -> The footer links do not lead to webpage, moreover their hover effect can be improved

Image ->

Adding ShadCn Toast in Project

[FEATURE] : About page Design

@punyakrit

we can add about page on route /about

and it will look like

please assign me i would like to work on that

Users schema and controllers.

User Schema to add what data is to be added in the user profile like username, email, social links, about user.
User controllers to perform CRUD operations for users.
If these are required to be stored in MongDB,.

[UI] : The footer links do not have the same transition as the navbar links

Description -> It is important for a good UI to have consistency, we can improve that by having the same hover effects across the entire webpage

Image ->

[Feat]: Implement Workflow for Closing Old Issues

This feature aims to automate the process of managing old issues, ensuring that the repository remains organized and focused on relevant tasks. By automatically closing old issues, it reduces manual overhead for repository maintainers and helps keep the issue tracker tidy and up-to-date.

Responsiveness of main page

Issue Description:
The main page of the application is not fully responsive, leading to layout issues and poor user experience on various devices, especially on mobile and tablet screens. The page needs to be redesigned and optimized to ensure it adapts smoothly to different screen sizes.

Request:
Please assign this issue to me. I will work on making the main page fully responsive, ensuring it provides an optimal user experience across all devices.

Thank you!

[Page Creation] : Creation of "Privacy Policy"

As of now this page just contains the heading, we can write a professional policy and make i responsive for small and medium sized devices as well

Home Page User Name text field has awkward outline

Home Page User Name text field has awkward outline

Please assign me this task as per GSSOC 24 rules and regulations

I want to make it more beautiful and with better user experience