Skip to content

Commit

Permalink
Fixes #127 #107 - deployment and run docker instances (#160)
Browse files Browse the repository at this point in the history
* Fixes #127 - removed unnecessary backend components, added docker run to README

* Addresses #107 - Added other web server deployment to README based on public docker image
  • Loading branch information
shollingsworth authored May 12, 2023
1 parent cf6c4a3 commit 5f7f017
Showing 1 changed file with 33 additions and 6 deletions.
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Trash AI: Web application for serverless image classification of trash
[![Website](https://img.shields.io/badge/Web-TrashAI.org-blue)](https://www.trashai.org)

[![Website](https://img.shields.io/badge/Web-TrashAI.org-blue)](https://www.trashai.org)

### Project Information

Expand All @@ -13,11 +13,37 @@
Trash AI is a web application where users can upload photos of litter, which will be labeled using computer vision to detect and categorize litter in the image by type. Early inspiration from [WADE AI](https://github.com/letsdoitworld/wade-ai) streamlined this development. Trash AI will enhance the abilities of researchers to quickly label trash in photos.

#### Demo

[![image](https://user-images.githubusercontent.com/26821843/188515526-33e1196b-6830-4187-8fe4-e68b2bd4019e.png)](https://youtu.be/HHrjUpQynUM)

## Deployment

You can simply go to www.trashai.org to start using the tool or deploy it yourself. Current self-deployment options are local deployment with docker to remote on Amazon Web Services (AWS).
You can simply go to www.trashai.org to start using the tool or deploy it yourself. Current self-deployment options are local deployment with docker to remote on Amazon Web Services (AWS).

### [Run Local Docker Instance](https://hub.docker.com/r/code4sac/trashai)

```
docker run -p 5150:5150 -it code4sac/trashai:latest
```

Navigate to to http://localhost:5150

### Deploy to Any Webserver

If you want to deploy this to a static web directory and serve it using
`apache` or `nginx`, you can do so with the following command using `/var/www/html`
as an example destination directory.

```
# create container from latest public trash ai docker image
id=$(docker create code4sac/trashai:latest)
# copy the static files
docker cp $id:/usr/share/nginx/html /var/www/html
# remove created container
docker rm -v $id
```

### [Run Local Docker Instance](https://hub.docker.com/r/code4sac/trashai)
```
Expand All @@ -26,21 +52,22 @@ docker run -p 5150:5150 -it code4sac/trashai:latest

### [Local Development](./docs/localdev.md)

- Run the environment live with localstack and docker.
- Run the environment live with localstack and docker.

### [AWS Deployment](./docs/git-aws-account-setup.md)

- Instructions on bringing up a new AWS deployment.
- Instructions on bringing up a new AWS deployment.

#### [Continuous Integration and Continuous Delivery (CI/CD) - Github Actions](./docs/github-actions.md)

- Mostly CD at this point.
- Mostly CD at this point.

#### [Github Actions AWS Deployment Role](./docs/github-actions-deployment-role.md)

- Runs the complex stuff so you don't have to.
- Runs the complex stuff so you don't have to.

## Contribute

We welcome contributions of all kinds.

To get started, look at the `Start Here` section of the [project board](https://github.com/orgs/code4sac/projects/13)
Expand Down

0 comments on commit 5f7f017

Please sign in to comment.