Skip to content

Latest commit

 

History

History
233 lines (171 loc) · 10.3 KB

README.md

File metadata and controls

233 lines (171 loc) · 10.3 KB
Raw

SwapReads.com

Connect, Exchange, Explore – Where Book Enthusiasts Swap Books and Discover New Literary Adventures!

License: MIT

🌟 Stars 🍴 Forks 🐛 Issues 🔔 Open PRs 🔕 Close PRs
Stars Forks Issues Open Pull Requests Close Pull Requests
SwapReads.com is the solution to common challenges faced by book enthusiasts in today's digital age. We've identified key problems and developed a platform that addresses them efficiently and effectively.

Featured In

Event Logo Event Name Event Description
GSSoC 24 GirlScript Summer of Code 2024 GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.

Table of Contents

The Problem:

  1. Limited Book Access:

    • Many readers struggle to find a variety of books locally.

  2. Book Expenses and Sustainability:

    • Buying new books is expensive, and the environmental impact of book production is a concern.

  3. Lack of Personalized Recommendations:

    • Generic book recommendations from algorithms lack a personal touch.

  4. Social Isolation in Reading:

    • Reading has become a solitary activity, with readers missing out on sharing thoughts and discoveries.

  5. Unused Book Collections:

    • Readers often have books that are read and then set aside, collecting dust.

How SwapReads.com Solves These Problems:

  1. Global Book Exchange:

    • SwapReads.com connects users globally, allowing them to exchange books regardless of location.

  2. Cost-Effective and Sustainable Reading:

    • By swapping books, users reduce expenses and contribute to a more sustainable reading culture.

  3. Personalized Recommendations and Community Trust:

    • Users share favorite reads, providing and receiving personalized recommendations from a trusted community.

  4. Social Connection and Book Discussions:

    • Features like private messaging and community forums foster a social environment for book discussions.

  5. Revitalizing Unused Book Collections:

    • SwapReads.com encourages users to share and exchange books that are sitting idle on their shelves.

💻 Tech Stacks

JavaScript HTML CSS Firebase

Open Innovation Challenge:

SwapReads.com actively participates in the Open Innovation Challenge by cultivating a global community of readers. Our platform champions open access to a wide range of books, promotes sustainable reading habits through book swapping, and harnesses user-generated content to offer personalized recommendations. With community-driven discussions and data-driven optimizations, SwapReads.com is committed to advancing the goals of inclusivity, sustainability, and collaborative innovation in the world of literature.

Join SwapReads.com today and embark on a literary journey like never before!

Getting Started

  1. Clone the repo
 git clone https://github.com/anuragverma108/SwapReads
  1. Install npm packages
npm install
  1. Run index.html with any browser (example: chrome etc).

Contribution

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have any suggestions for the project, such as reporting a bug, improving the UI, or enhancing the README.md file, feel free to open an issue to discuss it or directly create a pull request with the necessary changes.
  • Please make sure to check your spelling and grammar.
  • Create individual pull requests for each suggestion to keep changes focused and manageable.

Your involvement helps to improve the project and make it better for everyone. Thank you for your contributions!

Creating Pull Request

  1. Fork the Project:

    • Click on the "Fork" button at the top right corner of the repository's page on GitHub to create your own copy of the project.

  2. Clone Your Forked Repository:

    • Clone the forked repository to your local machine using the following command:
     git clone https://github.com/anuragverma108/SwapReads

  3. Create a New Branch and Move to the Branch:

    • Create a new branch for your changes and move to that branch using the following commands:
    git checkout -b <branch-name>

  4. Add Your Changes:

    • After you have made your changes, check the status of the changed files using the following command:
    git status -s
    • Add all the files to the staging area using the following command:
    git add .

    or add specific files using:

    git add <file_name1> <file_name2>

  5. Commit Your Changes:

    • Commit your changes with a descriptive message using the following command:
    git commit -m "<EXPLAIN-YOUR_CHANGES>"

  6. Push Your Changes:

    • Push your changes to your forked repository on GitHub using the following command:
    git push origin <branch-name>

  7. Open a Pull Request:

    • Go to the GitHub page of your forked repository, and you should see an option to create a pull request. Click on it, provide a descriptive title and description for your pull request, and then submit it.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the SwapReads repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the SwapReads repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the SwapReads repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the SwapReads repository.

⭐️ Support the Project If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.

Our Contributors ❤️

Thank you for contributing to our repository

Contributors

Show some ❤️ by starring this awesome repository!