Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swarooppatilx/scruter
Scruter is a local classifieds and community site designed to bring people together for buying, selling, and exchanging goods and services.
https://github.com/swarooppatilx/scruter
ejs expressjs gssoc-ext hacktoberfest hacktoberfest-accepted nodejs
Last synced: about 18 hours ago
JSON representation
Scruter is a local classifieds and community site designed to bring people together for buying, selling, and exchanging goods and services.
- Host: GitHub
- URL: https://github.com/swarooppatilx/scruter
- Owner: swarooppatilx
- License: gpl-3.0
- Created: 2024-07-17T11:40:37.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-01-29T03:45:15.000Z (4 days ago)
- Last Synced: 2025-01-31T22:37:14.969Z (1 day ago)
- Topics: ejs, expressjs, gssoc-ext, hacktoberfest, hacktoberfest-accepted, nodejs
- Language: TypeScript
- Homepage: https://scruter.vercel.app
- Size: 24.7 MB
- Stars: 26
- Watchers: 1
- Forks: 121
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
#
📦 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](#join-our-discord-server)
- [Overview 📌](#overview-📌)
- [Live Demo 🎥](#live-demo-🎥)
- [Technologies Used](#technologies-used)
- [Prerequisites 👈🏻](#prerequisites-👈🏻)
- [Installation 🛠️](#installation-🛠️)
- [Contributing 🌟](#contributing-🌟)
- [License 📜](#license-📜)
- [Project Admin ⚡](#project-admin-⚡)
- [Additional Tips 🔍](#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.
##
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](https://nodejs.org/).
- **MongoDB**: Set up an account at [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
- **Cloudinary Account**: Sign up at [Cloudinary](https://cloudinary.com/).
##
Follow these steps to set up Scruter locally:
1. **Clone the repository**
```bash
git clone https://github.com/swarooppatilx/scruter.git
cd scruter
```
2. **Install dependencies**
Run the following command to install the necessary packages:
```bash
npm install
```
3. **Create a .env file**
In the project root, create a .env file and add the following environment variables
```bash
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**
```bash
npm start
```
**Start the server with Nodemon**
Nodemon automatically restarts the server upon detecting file changes:
```bash
npm test
```
##
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**
```bash
git clone https://github.com/your-username/scruter.git
cd scruter
```
- **Create a new branch**
```bash
git checkout -b feature-branch-name
```
- **Add your changes**
```bash
git add .
```
- **Make your changes and commit them**
```bash
git commit -m 'Add some feature'
```
- **Push to the branch**
```bash
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](CONTRIBUTING.md) file.
---
##
This project is licensed under the [GPL-3.0 License](/LICENSE).
Project Admin ⚡
Swaroop Patil
##
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:
```bash
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:
```bash
npm start
```
If you're making significant changes, consider writing tests or ensuring existing tests pass by running:
```bash
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:
```bash
npm run lint
```
4. **Write Clear Commit Messages**
Always use clear and concise commit messages. A good format could be:
```bash
[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](https://github.com/swarooppatilx/scruter/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.