PdrTheCoder / uwa-marketplace

A UWA marketplace application as a group project for CITS5505
0 stars 1 forks source link

Introduction

This is a group project for CITS5505. We developed a trading platform and community for UWA students. As a UWA student, you can register your account and start selling your items and buying items from other students. Join us and start trading today!

We use python / flask to build a lightweight but full capable dynaic backend serving requests from clients. Flask framework features in providing a MVC (Model-View-Controller) architecture which offers modularized development pattern.

For frontend development, we use html, css, js and bootstrap style framework to provide a responsive and dynamic webpage.

Product Design

Team Information

Name Student ID Github Username
Pedro Wang 23870387 PdrTheCoder
Xuechen 23884895 eggplant0-0 CC
Yunhui Zhang 23839202 YunhuiZ
Yingqi Liu 23932642 SexyZoe

If you have any questions, please contact us via @student.uwa.edu.au. Thank you.

Development Setup

  1. Clone the repository

    https://github.com/PdrTheCoder/uwa-marketplace.git
    cd uwa-marketplace  
  2. Make sure you have python 3.10.2 installed
    check default python interpreter

    python
  3. Create a virtual environment

    python -m venv venv
  4. Activate virtualenv
    on Windows

    venv\Scripts\activate

    on Mac or linux OS systems

    source venv/bin/activate
  5. Install python package
    pip install -r requirements.txt

  6. Set secret key in environment
    In windows powershell

    $env:SECRET_KEY='a_strong_secret_key'  

    In mac

    export SECRET_KEY=<a_strong_secret_key>
  7. CD to app folder, migrate database

    cd uwamkp  
    flask db upgrade  
  8. Run development inside uwamkp folder

    flask run --debug  

Dev data populating

Can use insert_dev_data.py to insert some sample data. Please check the file for details

Run Unit tests and Selenium tests

cd uwa-marketplace  
python -m unittest discover