Manuscript (#69)

* my workflow * example templates for manuscript. * manuscript info * update citations * cleanup text * cite * update readme * contribute * add website badge * update web link * Update README.md * Update README.md * add video link * auto update * utility files device specific * move the pdf generator to workflows * test error in paper.bib * test citation style * add citations * add a few more citations * try without space * add all * no spaces allowed in citation names * add demo images * Update paper.md * give images some space * image captions * add mention of wade * update authors and acknowledgements * Updated with Dan's Recs * Mary Comments #69 (comment) * SteveO comments #69 (review) * Walter's comments #69 (review) * Create config.yml * Create bug.yml * Create feature.yml * hyperlink * Update bug.yml * Update feature.yml * Added in Kristiina and Kris's comments * Update README.md * #69 (comment) * #69 (comment) * #69 (comment) * #69 (comment) * #69 (comment) * #69 (comment) * add kris's comments * add WSL2 link * Update paper.md * add acknowledgements * #69 (comment) * #69 (comment) * #69 (comment)
code4sac · Nov 28, 2022 · 19270f0 · 19270f0
1 parent 8d8bedb
commit 19270f0
Show file tree

Hide file tree

Showing 9 changed files with 515 additions and 17 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,91 @@
+name: Bug report
+description: Report a problem you encountered
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to complete this bug report!
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Guidelines
+      description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+      options:
+        - label: I agree to follow this project's Contributing Guidelines.
+          required: true
+  - type: input
+    id: project
+    attributes:
+      label: Project Version
+      description: Which project versions are affected?
+      placeholder: "1.0, 2.2, 3.5.1"
+    validations:
+      required: false
+  - type: input
+    id: platform
+    attributes:
+      label: Platform and OS Version
+      description: Which platforms or operating systems are affected?
+      placeholder: "macOS 10.15.1, Ubuntu 20.04"
+    validations:
+      required: false
+  - type: input
+    id: existing-issues
+    attributes:
+      label: Existing Issues
+      description: Are there any similar existing issues?
+      placeholder: "#42"
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Clearly and concisely describe the bug.
+      placeholder: Tell us what happened.
+    validations:
+      required: true
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Steps to reproduce
+      value: |
+        1.
+        2.
+        3.
+        ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: What should have happened?
+      placeholder: What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: attachments
+    attributes:
+      label: Attachments
+      description: Please include code snippets, stack traces, or compiler errors.
+      placeholder: Paste code snippets, stack traces, and compiler errors here
+    validations:
+      required: false
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots or Videos
+      description: Add screenshots, gifs, or videos to help explain your problem.
+      placeholder: Upload screenshots, gifs, and videos here
+    validations:
+      required: false
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Information
+      description: Add any other useful information about the problem here.
+      placeholder: Is there any additional helpful information you can share?
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml
@@ -0,0 +1,48 @@
+name: Feature request
+description: Suggest an idea for this project
+title: "[Feature]: "
+labels: ["feature request", "enhancement", "feature"]
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to complete this form!
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Guidelines
+      description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+      options:
+        - label: I agree to follow this project's Contributing Guidelines.
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Clearly and concisely describe what you would like to change, add, or implement.
+      placeholder: Tell us your idea.
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: Is your feature request related to a problem?
+      placeholder: What problem will this solve?
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: How should this be solved?
+      placeholder: How do you think this should be implemented?
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: Are there other possible approaches?
+      placeholder: Can you think of any other options?
+    validations:
+      required: true
diff --git a/.github/workflows/draft-pdf.yml b/.github/workflows/draft-pdf.yml
@@ -0,0 +1,23 @@
+on: [push]
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v1
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: paper.pdf
diff --git a/.gitignore b/.gitignore
@@ -11,9 +11,18 @@ data
 # other
 .DS_Store
 
+#Google drive
+*.ini
+
+# R Studio
+*.Rproj
+
 **/*.pyc
 .python-version
 **/*.zip
 pyrightconfig.json
 archive/
 tmp/
+.Rproj.user
+delete.bat
+.Rhistory
diff --git a/README.md b/README.md
@@ -1,27 +1,38 @@
-## AI for Litter Detection (Web Application)
+# Trash AI: Web application for serverless image classification of trash
+[![Website](https://img.shields.io/badge/Web-TrashAI.org-blue)](https://www.trashai.org)
+
 
 ### Project Information
 
--   Sponsor: Win Cowger, UC Riverside - Trash Data Projects
--   Meeting Times: Wednesdays at 6:30pm (Weekly Brigade Meetings)
+-   Sponsor: Win Cowger, [Moore Institute for Plastic Pollution Research](https://mooreplasticresearch.org/)
+-   Meeting Times: Wednesdays at 6:30pm PT [Weekly Brigade Meetings](https://www.meetup.com/code4sac/)
 
 ### Project Summary
 
--   Description: Develop web application where users can upload photos of street litter which will be labeled using computer vision to detect and categorize litter type.
--   Benefit: Enhance abilities of researchers to quickly label photos and categorize types.
+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). 
 
 ### [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)
 
-### [AWS Deployments](./docs/git-aws-account-setup.md)
+- Instructions on bringing up a new AWS deployment.
 
-Instructions on bringing up a new deployment
+#### [Continuous Integration and Continuous Delivery (CI/CD) - Github Actions](./docs/github-actions.md)
 
-### [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)
 
-### [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, open an [issue](https://github.com/code4sac/trash-ai/issues) or [pull request](https://github.com/code4sac/trash-ai/pulls). Here are some ideas on [How to Contribute](https://opensource.guide/how-to-contribute/). Please adhere to this project's [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
diff --git a/docs/localdev.md b/docs/localdev.md
@@ -2,7 +2,7 @@
 
 When doing local development, you can run this stack in the background and
 edit files in the `/backend` and `/frontend` directories and the environment
-with automatically update.
+with automatic update.
 
 The listening port for the web frontend defaults to `http://localhost:5150`,
 The backend is exposed via `http://localhost:4000` by default.
@@ -13,17 +13,23 @@ These values can be adjusted by editing the localdev env file [.env](../localdev
 
 ## _*IMPORTANT*_
 
-Pushing / merging PR's to any branches with a prefix of `aws/` will
-trigger deployment actions, when developing locally, create a new branch
-and submit a pull request to `aws/trashai-staging`
+It's suggested you work in branch `local` by creating your own local branch when developing
+Pushing / merging PR's to any branches with a prefix of `aws/` will trigger deployment actions
+For full functionality you will want to get a Google Maps API key and name it VITE_GOOGLE_MAPS_API_KEY, but it is not required
+=======
+
 
 ---
 # Set up 
 
 ## Operating System Requirements
 -   Linux
--   MacOS
+-   MacOS (testing)
 -   Windows using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install)
+    -   WSL Integration on Ubuntu must be enabled in Docker options -> Resources -> WSL Integration
+    -   Repo must be inside Ubuntu (i.e. ~/code/trash-ai)
+    -   Make local must be run from a WSL (Ubuntu) terminal
+    -   Take note of docker-compose installation (installing through apt may not install the correct version)
 
 ## 1. Install Required Software
 -   docker desktop (or configure docker engine and docker-compose another way)