Skip to content

Latest commit

 

History

History
126 lines (86 loc) · 2.87 KB

README.md

File metadata and controls

126 lines (86 loc) · 2.87 KB

Scruter

Scruter is a local classifieds and community site designed to bring people together for buying, selling, and exchanging goods and services.

Live Demo

Access the live version of Scruter at scruter.onrender.com.

If above link is not working try this scruter2.onrender.com.

Scruter Preview

Features

  • Local Commerce: Connect with your community to buy, sell, and find goods and services.
  • Classified Ads: Post and browse ads for housing, food, and items for sale.
  • Community Connection: Discover what your local area has to offer and interact with others nearby.

Prerequisites

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

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

[label .env ]
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

Technologies Used

Scruter is built using the following technologies:

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

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.

License

This project is licensed under the GPL-3.0 License.