https://github.com/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://github.com/punyakrit/social-share

gssoc24 nextauth nextjs open-source socialshare tailwindcss typescript

Last synced: 5 months ago
JSON representation

Host: GitHub
URL: https://github.com/punyakrit/social-share
Owner: punyakrit
License: mit
Created: 2024-05-17T14:41:53.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-07-30T05:30:06.000Z (11 months ago)
Last Synced: 2025-01-23T15:09:01.098Z (5 months ago)
Topics: gssoc24, nextauth, nextjs, open-source, socialshare, tailwindcss, typescript
Language: TypeScript
Homepage: https://www.sharehub.xyz/
Size: 2.01 MB
Stars: 24
Watchers: 1
Forks: 47
Open Issues: 51
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

ShareHub

## Table of Contents
- [Code of Conduct](#code-of-conduct)
- [Contributing](#contributing)
- [Setting Up Locally](#setting-up-locally)
- [Connecting to MongoDB](#connecting-to-mongodb)
- [Creating Google Credentials](#creating-google-credentials)
- [Running the Development Server](#running-the-development-server)
- [Learn More](#learn-more)
- [License](#license)
- [Open Source Programs](#open-source-programs)
- [Acknowledgements](#acknowledgements)
- [Contributors](#contributors)

## Code of Conduct
Please read our [CODE OF CONDUCT](CODE_OF_CONDUCT.md) 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.

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

3. Navigate to the project directory.

```bash
cd social-share
```

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

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

5. Check remotes for this repository.

```bash
git remote -v
```

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

```bash
git pull upstream main
```

7. Create a new branch.

```bash
git checkout -b
```

8. Make changes to the code base.

9. Stage your changes.

```bash
git add -A
```

10. Commit your changes.

```bash
git commit -m "relevant message"
```

11. Push your local commits to the remote repo.

```bash
git push -u origin
```

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](contributing.md) 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.

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

_Run the command to install npm package_

```markdown
npm install
```

### STEPS TO CONNECT WITH THE MONGODB

```bash
cp .env.example .env
```

```bash
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

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

### Create a new project and name it

Dashboard
Alt text