Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Updated repo with instructions
tmanik committed Aug 23, 2024
1 parent d6e53bc commit a9a1876
Showing 61 changed files with 1,100 additions and 1,938,294 deletions.
Binary file modified .DS_Store
Binary file not shown.
14 changes: 1 addition & 13 deletions .gitignore
@@ -1,13 +1 @@
# ignore the data files from 01-basic-deployment
01-basic-deployment/scripts/data/combined_data_cleaned.csv
01-basic-deployment/scripts/data/combined_data.csv

# ignore the done files from 01-basic-deployment
01-basic-deployment/scripts/extract_done
01-basic-deployment/scripts/transform_done

# ignore drafts
archive/*

# ignore all files that are .env
*.env
arch/
78 changes: 78 additions & 0 deletions 00-prerequisites/README.md
@@ -0,0 +1,78 @@
# Workshop Prerequisites

To successfully complete this workshop, you'll need the following tools and accounts:

0. Cloning the repository
1. Docker and Docker Compose
2. Python 3.9+
3. A text editor or IDE
4. A DockerHub account
5. An AWS and/or GCP account

## Installation Instructions

### 0. Clone this GitHub repository

You can clone the repository to your local machine by running:

```shell
git clone https://github.com/Internet2/...
```

### 1. Docker and Docker Compose

Docker is essential for containerizing our applications, while Docker Compose helps us define and run multi-container Docker applications.

- **For Windows and Mac**: Download and install Docker Desktop from the [official Docker website](https://www.docker.com/products/docker-desktop). This includes both Docker and Docker Compose.
- **For Linux**: Follow the installation instructions for your specific distribution on the [Docker documentation](https://docs.docker.com/engine/install/). Then, install Docker Compose separately following these [instructions](https://docs.docker.com/compose/install/).

Verify the installation by running:
```shell
docker --version
docker-compose --version
```

### 2. Python 3.9+

Python is required for running our Flask application and data processing scripts.

- Download and install Python from the [official Python website](https://www.python.org/downloads/). Make sure to choose version 3.9 or higher.

Verify the installation by running:

```shell
python --version
```

### 3. Text Editor or IDE

You'll need a text editor or Integrated Development Environment (IDE) to view and edit code files. Some popular options include:

- Visual Studio Code (recommended): [Download here](https://code.visualstudio.com/)
- PyCharm: [Download here](https://www.jetbrains.com/pycharm/)
- Sublime Text: [Download here](https://www.sublimetext.com/)

The instructors will be using Visual Studio Code.

### 4. DockerHub Account

You'll need a DockerHub account to push and pull Docker images.

- Sign up for a free account at [DockerHub](https://hub.docker.com/)

### 5. AWS and/or GCP Account


## Verifying Your Setup

After installing the prerequisites, open a terminal or command prompt and run the following commands to ensure everything is set up correctly:

```shell
docker --version
docker-compose --version
python --version
```

Each command should return a version number without any errors.

If you encounter any issues during the installation or verification process, please consult the official documentation for the respective tools or seek assistance from the workshop organizers.
18 changes: 0 additions & 18 deletions 01-basic-deployment/Dockerfile

This file was deleted.

10 changes: 0 additions & 10 deletions 01-basic-deployment/app/entrypoint_extract.sh

This file was deleted.

11 changes: 0 additions & 11 deletions 01-basic-deployment/app/entrypoint_load.sh

This file was deleted.

14 changes: 0 additions & 14 deletions 01-basic-deployment/app/entrypoint_transform.sh

This file was deleted.

41 changes: 0 additions & 41 deletions 01-basic-deployment/docker-compose.yml

This file was deleted.

18 changes: 0 additions & 18 deletions 01-basic-deployment/requirements.txt

This file was deleted.

Binary file removed 01-basic-deployment/scripts/.DS_Store
Binary file not shown.

0 comments on commit a9a1876

Please sign in to comment.