Containerized App Exercise

Description

Sonus is a a speech-to-text application that allows the user to input speech through access to a microphone, as well as with an audio file. By providing more input, the application should become more accuracte wit its translation, as the machine learning client analyzes and keeps track of background noise!

Team Members

Lucia Song
Chelsea Hodgson
Yeshni Savadatti
Alan Zhao

How to Run the Application

1. Make sure to install, run, and login to Docker Destop on your local machine. You can do so with this link.
   

2. Make sure to have docker-compose installed.
   

3. Clone the repository by using the command:
   git clone [email protected]:software-students-fall2024/4-containers-scoobygang2.git
   

4. Navigate into the project root folder.

5. To run the app, use the command:
   docker-compose up --build
   

Or run in detatched mode:
docker-compose up -d

6. To view the app, go to http://localhost:3000/.
   

7. To shut down the containers, run the command:
   docker-compose down
   

How to Run Tests the Machine Learning Client

1. Navigate into the machine-learning-client directory by using the command:
   cd machine-learning-client
   

2. Set up a virtual environment, by using the commands: pip3 install pipenv OR pip install pipenv
   

3. Activate the virtual environment:
   pipenv shell
   

4. To run tests, use the command: python3 -m pytest

How to Run Tests the Web Application

1. Navigate into web-app directory by using the command:
   cd web-app
   

2. Set up a virtual environment, by using the commands: pip3 install pipenv OR pip install pipenv
   

3. Activate the virtual environment:
   pipenv shell
   

4. To run tests, use the command: python3 -m pytest

How to Contribute to the Project

We welcome contributions! Here’s how you can help:

1. Fork the Repository: Start by forking the repository and cloning your fork to your local machine.
2. Create and Set up Virtual Environment: Set up a virtual environment with pipenv, using:
   pip install pipenv OR pip3 install pipenv
   and then:
   pipenv shell
   
3. Install Dependencies: Make sure you have the necessary dependencies installed if pipenv was not used:
   pip install -r requirements.txt OR pip3 install -r requirements.txt
   
4. Create a New Branch: Create a branch for your feature or bug fix.
5. Make Changes and Write Tests: Make your changes, ensuring that you add or update tests as needed in the tests directory. To run tests, use the command:
   python -m pytest OR python3 -m pytest
   
6. Commit and Push Your Changes: After finishing your work on local machine, commit and push your changes to git.
7. Create a Pull Request: Go to the original repository and create a pull request for your changes.

Please ensure your codes come with meaningful commit messages and follow the PEP 8 standard, which can be found in detail here.