search

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
https://www.sharehub.xyz/
MIT License
23 stars 48 forks source link
gssoc24 nextauth nextjs open-source socialshare tailwindcss typescript

readme

ShareHub

ShareHub

Table of Contents

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
  1. Navigate to the project directory.
cd social-share
  1. Add a refernce(remote) to the original repository.
git remote add upstream https://github.com/punyakrit/social-share.git
  1. Check remotes for this repository.
git remote -v
  1. Always take a pull from the main upstream repository.
git pull upstream main
  1. Create a new branch.
git checkout -b <your_branch_name>

  1. Make changes to the code base.

  2. Stage your changes.

git add -A
  1. Commit your changes.
git commit -m "relevant message"
  1. Push your local commits to the remote repo.
git push -u origin <your_branch_name>
  1. 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

Dashboard Alt text

Select the project

Alt text

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

Alt text

Add data as same as in the given image

Alt text

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.

gssoc

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)