Skip to content

Latest commit

 

History

History
158 lines (110 loc) · 5.05 KB

README.md

File metadata and controls

158 lines (110 loc) · 5.05 KB
Raw

📦 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.

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.

Scruter Preview

Live Demo 🎥

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

Technologies Used

Scruter is built using the following technologies:

  • Node.js
  • Express.js
  • MongoDB
  • EJS (Embedded JavaScript templating)
  • Cloudinary (Image hosting)
  • Bootstrap (CSS framework)

Prerequisites 👈🏻

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

Back To Top

Installation 🛠️

Follow these steps to set up Scruter locally:

  1. Clone the repository
git clone https://github.com/swarooppatilx/scruter.git
cd scruter
  1. Install dependencies

Run the following command to install the necessary packages:

npm install
  1. 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
  1. 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.

Please refer to the Contributing.md file for detailed guidelines on how to contribute to this project.

License 📜

This project is licensed under the GPL-3.0 License.

Project Admin ⚡

Swaroop Patil

Contributors

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

Back To Top