Swat Swap: Swarthmore College Local Marketplace

Welcome to Swat Swap, a community-driven platform tailored for Swarthmore College students to facilitate the exchange of goods and services. This GitHub repository contains the source code and documentation for the Swat Swap website.

Table of Contents

• Introduction
• Key Features
• Getting Started
• Installation
• Usage
• Contributing
• License

Introduction

Swarthmore College boasts a vibrant community, and Swat Swap aims to enhance the local trading experience by providing a platform for students to buy, sell, or trade items within the college ecosystem. This platform fosters a sense of community and connectivity among Swarthmore students.

Key Features

• Intuitive Interface: Swat Swap offers an easy-to-use interface designed for seamless navigation and listing management.

• Categories and Tags: Organize listings efficiently using predefined categories and tags, making it easy for users to find what they need.

• Secure Messaging: Facilitate secure communication between users for smooth and reliable transactions.

• Search and Filters: Users can efficiently search for specific items or apply filters to refine results based on preferences.

• User Profiles: Build trust within the community by exploring user profiles and transaction history.

Getting Started

To begin using Swat Swap, follow these steps:

1. Clone the repository to your local machine.
2. Install the necessary dependencies.
3. Configure the database settings.
4. Run the application locally.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/swat-swap.git

2. Install dependencies:

   npm install

3. Configure the database:

   • Set up a local or remote database.
   • Update the database configuration in config.js.

   Updating schema

   bin/migrate.sh

   Connecting to database

   bin/dbconnect.sh

4. Start the Docker dev server:

   docker compose up

Visit http://localhost:3000 to access Swat Swap locally.

Usage

1. Register or log in to your account.
2. Create a listing for the item you want to sell or trade.
3. Browse available listings based on categories or use the search feature.
4. Communicate with other users through secure messaging.
5. Finalize the transaction and enjoy your new item!

Contributing

We welcome contributions to improve Swat Swap. To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and submit a pull request.

For major changes, please open an issue first to discuss the proposed changes.

License

This project is licensed under the MIT License.

Feel free to explore and enhance Swat Swap to make it an even better platform for the Swarthmore College community! If you have any questions or issues, please don't hesitate to open an issue on GitHub.