COMP90082_S1_TO_2021

COMP90082_S1_TO_2021 is a subject project that is developed by 15 students from the University of Melbourne for Rocky Valley Bikes & Snow Sports collaborating with Squizz which is a universally connected commerce platform that allows people and organisations to connect, automate and trade, while seamlessly collaborating through trusted relationships.

At Rocky Valley we have plenty of activities to make your holiday fun. From Ski hire, including cross country, back country, downhill and snowboards in winter to bike hire, golf clubs and kayaks in summer. We also stock a large range of cycing ...

Folder structure

.
├── code                                        # Code
|   ├── end_to_end_testing                      # End-to-end testing (Cypress)
│   ├── backend                                 # Backend Code (FastAPI)
|       ├── tests                               # Unit tests for the backend
|       ├── Dockerfile                          # Dockerfile to deploy the backend
│       └── ...                                 # ...
│   └── frontend                                # Frontend Code (ReactJS + MobX + CSS-IN-JS)
|       ├── Dockerfile                          # Dockerfile to deploy the frontend
│       └── ...                                 # ...
├── db_migration_scripts                        # Migration scripts
|   ├── data sample                             # Data sample exported from the db
│   ├── data                                    # MySQL migration scripts to import the database on local
│   ├── deploydata                              # MySQL migration scripts used with Docker
│   ├── reference files                         # Price data received from Rocky Valley
│   └── Dockerfile                              # Dockerfile to deploy a MySQL database
├── deployment                                  # Deployment Guide (Local & Auto)
│   ├── scripts                                 # Scripts to deploy (planning to do in week 10)
│   ├── CICD Pipeline.pdf                       # The CI/CD pipeline
├── diagrams                                    # Documents about the product architecutre
├── documents                                   # All other relevant docs
├── prototypes                                  # All the prototypes created for the application
├── test                                        # Test plans for the product
├── LICENSE
└── README.md

Deployment guide

Documented here: Local Deployment Guide

(NEW) Docker Deployment Guide (All components: Database (MySQL), Backend, Frontend are now Dockerized), note that the local or manual deployment is still usable and if anything bug/issue to arise, you can always go back to it.

Follow these steps to deploy with Docker:

1. Stop your local MySQL server (it will occupied port 3306 which makes the MySQL inside Docker won't be able to use that port). (in case you want to go back to local deployment, simply re-open your local MySQL).

2. The database .sql schema file inside

   db_migration_scripts/deploydata/

   will be import and use, so throw the version you want to use inside (remember only 1 file/version at a time).

3. Go to

   code/backend/app/api

   make sure inside database.py the HOST is

   HOST="mysqldb"

   (in case you want local deployment, change it back to HOST="localhost:3306").

4. Go to

   code/frontend/

   and inside the file "webpack.base.conf", make sure to set

   devServer: {
        host: '0.0.0.0',
        ...

   for Docker deployment. (incase you want to go back to local/manual deployment, simply change it back to 127.0.0.1)

   devServer: {
        host: '127.0.0.1',
        ...

5. Navigate to "COMP90082_S1_TO_2021" folder/directory (or in the same folder with the docker-compose.yml file).

6. Run this command:

    docker-compose up -d --build
   

   and voila!!!

IMPORTANT: Everytime you make change to the code, remember to run step 6 again. If any problem persists, please "DELETE" the current Container/Image and then re-run step 6 again. This can be done easily with Docker Desktop, Go to "Containers/Apps" and hit the "Trash Bin icon" to delete it (will cost a few secs).

CONTACT

Please contact [email protected] or [email protected] if you have any concerns.

LICENSE

MIT