- 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
Please read our CODE OF CONDUCT for detailed guidelines.
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:
-
Fork this repository.
-
Clone the forked repository.
git clone https://github.com/punyakrit/social-share.git
- Navigate to the project directory.
cd social-share
- Add a refernce(remote) to the original repository.
git remote add upstream https://github.com/punyakrit/social-share.git
- Check remotes for this repository.
git remote -v
- Always take a pull from the main upstream repository.
git pull upstream main
- Create a new branch.
git checkout -b <your_branch_name>
-
Make changes to the code base.
-
Stage your changes.
git add -A
- Commit your changes.
git commit -m "relevant message"
- Push your local commits to the remote repo.
git push -u origin <your_branch_name>
- Create a pull request from your branch to the original repository.
Congratulations! 🎉 you've made your contribution.
If you would like to contribute to the project, please follow our CONTRIBUTING guidelines.
- Fork the repository (Click the Fork button in the top right on Github)
- 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
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
https://console.cloud.google.com/
Save and Copy the GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET
http://localhost:3000
test
# 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.
This project is licensed under License
To learn more about the project, check out our Learn More page.
This project is a part of GirlScript Summer of code. We welcome contibutions from the community to help improve the project social-share.
We would like to express our gratitude to the following contributors for their valuable contributions to Social Share
Developed with ❤️ by The Social Share Team