Skip to content

Installation

Jeremy Friesen edited this page Feb 20, 2024 · 3 revisions

Installation Guide for A.I. Snow Day Predictor

Welcome to the installation guide for the A.I. Snow Day Predictor. This page provides step-by-step instructions to help you get the application running on your machine.

Prerequisites

Before you begin the installation process, ensure you have the following installed on your system:

  • Docker: The application is containerized, which means Docker is required to run it. Download and install Docker for your operating system from Docker's official website.
  • Git: Needed to clone the repository. If you don't have Git installed, follow the instructions on Git's official site.

Installation Steps

1. Clone the Repository

Start by cloning the A.I. Snow Day Predictor repository to your local machine. Open a terminal or command prompt and run the following command:

git clone https://github.com/jeremyfriesengithub/ai-snow-day-predictor.git

2. Navigate to the Project Directory

Change to the project directory with the following command:

cd ai-snow-day-predictor

3. Build and Run with Docker

With Docker installed and running, you can now build and start the application using Docker Compose. Run the following command in the terminal:

docker-compose up --build

This command builds the Docker images and starts the containers defined in your docker-compose.yml file. The --build option ensures that Docker rebuilds the images if there have been any changes.

4. Accessing the Application

Once the containers are up and running, the A.I. Snow Day Predictor should be accessible through a web browser. By default, the application can be accessed at:

http://localhost:1234

Adjust the port number if your setup uses a different port.

Troubleshooting

If you encounter issues during the installation, consider the following common troubleshooting steps:

  • Docker Not Running: Make sure the Docker daemon is running before you execute docker-compose up.
  • Port Conflicts: If the application fails to start due to port conflicts, check if another application is using the same port. You can change the port in the docker-compose.yml file if necessary.
  • Youtube Tutorial: Watch my Youtube tutorial here if you need further assistance!

Next Steps

Congratulations! You've successfully installed the A.I. Snow Day Predictor. Explore the application, input data, and see how it predicts snow days. For more information on how to use the application or contribute to its development, check out the wiki home page.