diff --git a/.github/workflows/ml-test.yml b/.github/workflows/ml-test.yml index 626126b..3bcdedf 100644 --- a/.github/workflows/ml-test.yml +++ b/.github/workflows/ml-test.yml @@ -39,5 +39,5 @@ jobs: - name: Run tests run: | - pipenv run pytest --cov=machine_learning_client.py ml_tests.py + pipenv run pytest --cov=machine_learning_client ml_tests.py working-directory: machine-learning-client/tests \ No newline at end of file diff --git a/README.md b/README.md index ad6928d..1eed185 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Interview Review WebApp -![WebApp Machine Learning build test](https://https://github.com/software-students-fall2023/4-containerized-app-exercise-rizzballs/blob/main/.github/workflows/event-logger.yml/badge.svg) -![WebApp Subsystems build test](https://https://github.com/software-students-fall2023/4-containerized-app-exercise-rizzballs/blob/main/.github/workflows/lint.yml/badge.svg) + ## What is our WebApp? @@ -8,16 +7,20 @@ Our WebApp is designed to help users practice and improve their interview skills ## Installation and Usage +### Prerequisites +1. ensure you have python 3.11 or higher installed +2. ensure you have have Docker installed and running on your computer. +3. optionally have docker Desktop ### Method 1: Cloning the Github Repository 1. Clone the directory through Git Bash with the command: ``` -https://github.com/software-students-fall2023/4-containerized-app-exercise-rizzballs.git +git clone https://github.com/software-students-fall2023/4-containerized-app-exercise-rizzballs.git ``` -2. Open Docker Desktop +2. Open Docker Desktop or a new terminal -3. In your command prompt, access the directory where you cloned the repository: +3. In your command prompt/terminal, access the directory where you cloned the repository: ``` cd "path_to_directory" ``` @@ -27,9 +30,36 @@ cd "path_to_directory" docker-compose build docker-compose up ``` - 5. Now, access the http://127.0.0.1:5000/ in your browser of choice. +6. to end the session +``` +docker-compose stop +``` +or +``` +docker-compose down +``` + +### Note for MacOS Users: +1. after doing docker-compose build and then running docker-compose up leads you to this error: +``` +Error response from daemon: Ports are not available: listen tcp 0.0.0.0:5000: bind: address already in use. + +``` +2. to trouble shoot thisin your terminal run: +``` +lsof -i tcp:5000 +``` +3. and kill that process by doing +``` +kill -9 +``` +4. if however, two processes appear when you run the above command then "Airplay" should be turned off +5. to do so go to system settings -> search up air drop and click on "AirDrop and Handoff" -> from there turn off "AirPlay receiver". +6. and then try docker-compose up again. + + ### Install ffmpeg (Windows) 1. Go to the official ffmpeg website, hover over the windows icon, and click Windows builds from gyan.dev 2. Download ffmpeg-git-full.7z under "latest git master branch build @@ -38,6 +68,13 @@ docker-compose up This should allow you to use ffmpeg while using our program. Make sure to use a clean shell to make sure it is up to date +### Install ffmpeg (Windows) +1. in your terminal type in +``` +brew install ffmpeg +``` +This should allow you to use ffmpeg while using our program + ## Contributors - [Andrew Huang](https://github.com/andrew0022)