README.md

📦 Scruter 🛒

Hi there, Enjoy the World of Open Source Contribution

Scruter is a local classifieds and community platform where people can connect, buy, sell, and exchange services.

Table of Contents

• Join our Discord Server
• Overview 📌
• Live Demo 🎥
• Technologies Used
• Prerequisites 👈🏻
• Installation 🛠️
• Contributing 🌟
• License 📜
• Project Admin ⚡
• Additional Tips 🔍

Join our Discord Server

🌟 Stars	🍴 Forks	🐛 Issues	🔔 Open PRs	🔕 Close PRs	🌐Contributors	📂 Repo Size	🆔 LIcense

This project is now OFFICIALLY accepted for✔

Event Logo	Event Name	Event Description
	GirlScript Summer of Code 2024	GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation.
	Hacktoberfest 2024	Hacktoberfest is a month-long celebration of open source software run by DigitalOcean, GitHub, and Twilio.

Overview 📌

• 📦 Scruter helps you discover local services, post ads, and interact with your community.
• 🛒 A platform for local commerce, perfect for buying and selling goods and services within your area.
• 🚀 Explore the live demo and see what Scruter has to offer!
• 💻 Contributions are welcome to make this project even better for the community.

Live Demo 🎥

Access the live version of Scruter at scruter.vercel.app

Technologies Used

Scruter is built using the following technologies:

HTML	CSS	Javascript	Node.js	Express.js	MongoDB	EJS	Cloudinary	Bootstrap

Prerequisites 👈🏻

Before setting up the project, ensure you have the following installed:

• Node.js: Download and install from nodejs.org.
• MongoDB: Set up an account at MongoDB Atlas.
• Cloudinary Account: Sign up at Cloudinary.

Installation 🛠️

Follow these steps to set up Scruter locally:

1. Clone the repository

git clone https://github.com/swarooppatilx/scruter.git
cd scruter

2. Install dependencies

Run the following command to install the necessary packages:

npm install

3. Create a .env file

In the project root, create a .env file and add the following environment variables

DB_URL=your_mongo_db_url
SESSION_SECRET=your_session_secret
CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name
CLOUDINARY_API_KEY=your_cloudinary_api_key
CLOUDINARY_API_SECRET=your_cloudinary_api_secret

4. Running the Application

To start the application, use one of the following commands:

Start the server

npm start

Start the server with Nodemon

Nodemon automatically restarts the server upon detecting file changes:

npm test

Contributing 🌟

Contributions are welcome! Follow these steps to contribute:

• Fork the repository
  Click the "Fork" button at the top-right corner of the repository page to create a personal copy.

• Clone your forked repository

  git clone https://github.com/your-username/scruter.git
  cd scruter

• Create a new branch

  git checkout -b feature-branch-name

• Add your changes

  git add .

• Make your changes and commit them

  git commit -m 'Add some feature'

• Push to the branch

  git push origin feature-branch-name

• Submit a pull request
  Go to the original repository and click on the "Pull Request" button to submit your changes.

For detailed guidelines on how to contribute to this project, please refer to the CONTRIBUTING.md file.

---

License 📜

This project is licensed under the GPL-3.0 License.

Project Admin ⚡

Swaroop Patil

Additional Tips 🔍

Here are a few tips to ensure a smooth contribution process:

1. Stay Updated
   Keep your forked repository up-to-date by syncing it with the original repository:

   git fetch upstream
   git checkout main
   git merge upstream/main

2. Test Thoroughly
   Make sure to test your changes thoroughly before submitting them. You can do this by running the project locally:

   npm start

   If you're making significant changes, consider writing tests or ensuring existing tests pass by running:

   npm test

3. Follow the Code Style Guidelines
   Adhering to the project's code style guidelines is crucial. If available, use the provided linting tools to ensure consistent code style:

   npm run lint

4. Write Clear Commit Messages
   Always use clear and concise commit messages. A good format could be:

   [feature] Add feature to enhance user dashboard

5. Engage in Discussions
   If you're unsure about a feature or want to suggest improvements, engage with the maintainers via the Discussions section.

Contributors

Big thanks to all the contributors who have helped make Scruter a better platform! 🎉

Happy coding and thanks for your contributions! 🎉

🌐 Connect with Me

---

Thank you for visiting! Feel free to reach out through any of the links above.