CampusMarket is a Django-based e-commerce platform designed to facilitate buying and selling within a campus environment. This project allows users to list items for sale, search for items, and communicate with other users through a conversation system.
- Introduction
- Project Overview
- Features
- Technologies Used
- Database Schema
- Getting Your API Key
- Getting Started
- Deployment
- Contributing
- License
CampusMarket offers the following features:
Feature | Description |
---|---|
User Accounts | Register, log in, and manage personal information. |
Dashboard | View and manage user-created items, with edit and delete options. |
Item Listing | List items for sale, search, and filter based on categories and criteria. |
Conversations | Secure communication between users through a built-in messaging system. |
Search API | Integrates with an external API for real-time product data. |
CampusMarket is built with the following technologies:
Technology | Description |
---|---|
Django | A high-level Python web framework. |
SQLite | Default database used for local development. |
HTML/Tailwind-CSS | Front-end for rendering templates and styling. |
JavaScript | Enhances interactivity on the front-end. |
PythonAnywhere | Deployment platform for Django applications. |
To get started with CampusMarket, follow these steps:
-
Clone the repository:
git clone https://github.com/your-username/campusmarket.git cd campusmarket
-
Set up a virtual environment:
python3 -m venv env source env/bin/activate
-
Install dependencies:
pip install -r requirements.txt
-
Run migrations:
python manage.py migrate
-
Run the development server:
python manage.py runserver
-
Access the application: Open a web browser and go to
http://127.0.0.1:8000/
.
To access the Real-Time Product Search API for integrating with CampusMarket, you need to obtain an API key from RapidAPI. Follow these steps to get your API key:
-
Visit the RapidAPI Marketplace: Go to Real-Time Product Search API page on the RapidAPI website.
-
Sign Up or Log In: If you don't have an account, sign up for a RapidAPI account. If you already have one, log in to your account.
-
Subscribe to the API: Subscribe to the Real-Time Product Search API to get access. This may involve selecting a plan that suits your needs.
-
Get Your API Key: After subscribing, you will receive an API key. This key will be used to authenticate your requests to the API.
-
Use the API Key: Once you have your API key, you can use it to make requests to the Real-Time Product Search API and integrate it into CampusMarket for real-time product data.
CampusMarket is deployed on PythonAnywhere.
https://campusmarket.pythonanywhere.com/
Contributions are welcome! If you want to contribute to CampusMarket, please follow these guidelines:
- Fork the repository.
- Create a new branch for your changes.
- Submit a pull request with a clear explanation of your changes.