Merge branch 'development' of https://github.com/hotosm/fmtm into fix…

…-project-details-map
hotosm · Oct 13, 2023 · 8c252c9 · 8c252c9
2 parents d7b59b8 + ba9c2e5
commit 8c252c9
Show file tree

Hide file tree

Showing 28 changed files with 16,836 additions and 179 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -23,41 +23,83 @@
       "profile": "https://www.hotosm.org",
       "contributions": ["maintenance", "mentoring", "code", "review", "ideas"]
     },
+    {
+      "login": "spwoodcock",
+      "name": "Sam",
+      "avatar_url": "https://avatars.githubusercontent.com/u/78538841?v=4",
+      "profile": "https://github.com/spwoodcock",
+      "contributions": ["code", "review", "infra", "ideas", "maintenance"]
+    },
+    {
+      "login": "varun2948",
+      "name": "Deepak Pradhan (Varun)",
+      "avatar_url": "https://avatars.githubusercontent.com/u/37866666?v=4",
+      "profile": "https://github.com/varun2948",
+      "contributions": ["code", "ideas", "maintenance"]
+    },
+    {
+      "login": "nrjadkry",
+      "name": "Niraj Adhikari",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41701707?v=4",
+      "profile": "https://github.com/nrjadkry",
+      "contributions": ["code", "ideas", "maintenance"]
+    },
     {
       "login": "krtonga",
       "name": "krtonga",
       "avatar_url": "https://avatars.githubusercontent.com/u/7307817?v=4",
       "profile": "https://github.com/krtonga",
       "contributions": ["code", "doc", "tool", "ideas"]
     },
-    {
-      "login": "spwoodcock",
-      "name": "Sam",
-      "avatar_url": "https://avatars.githubusercontent.com/u/78538841?v=4",
-      "profile": "https://github.com/spwoodcock",
-      "contributions": ["code", "review", "infra", "ideas"]
-    },
     {
       "login": "petya-kangalova",
       "name": "Petya ",
       "avatar_url": "https://avatars.githubusercontent.com/u/98902727?v=4",
       "profile": "https://www.hotosm.org/people/petya-kangalova/",
       "contributions": ["doc", "eventOrganizing", "ideas"]
     },
+    {
+      "login": "Sujanadh",
+      "name": "Sujan Adhikari",
+      "avatar_url": "https://avatars.githubusercontent.com/u/109404840?v=4",
+      "profile": "https://github.com/Sujanadh",
+      "contributions": ["code"]
+    },
     {
       "login": "Mudi-business",
       "name": "Mohamed Bakari Mohamed",
       "avatar_url": "https://avatars.githubusercontent.com/u/52991565?v=4",
       "profile": "http://zanrevenue.org",
       "contributions": ["code"]
     },
+    {
+      "login": "NSUWAL123",
+      "name": "Nishit Suwal",
+      "avatar_url": "https://avatars.githubusercontent.com/u/81785002?v=4",
+      "profile": "https://github.com/NSUWAL123",
+      "contributions": ["code"]
+    },
     {
       "login": "biomassives",
       "name": "G. Willson",
       "avatar_url": "https://avatars.githubusercontent.com/u/4379874?v=4",
       "profile": "https://www.scdhub.org",
       "contributions": ["code"]
     },
+    {
+      "login": "JoltCode",
+      "name": "JoltCode",
+      "avatar_url": "https://avatars.githubusercontent.com/u/46378904?v=4",
+      "profile": "https://github.com/JoltCode",
+      "contributions": ["code"]
+    },
+    {
+      "login": "neelimagoogly",
+      "name": "Neelima Mohanty",
+      "avatar_url": "https://avatars.githubusercontent.com/u/97789856?v=4",
+      "profile": "https://github.com/neelimagoogly",
+      "contributions": ["doc"]
+    },
     {
       "login": "Ndacyayisenga-droid",
       "name": "Tayebwa Noah",
@@ -92,15 +134,9 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/75838716?v=4",
       "profile": "https://github.com/Roseford",
       "contributions": ["doc"]
-    },
-    {
-      "login": "neelimagoogly",
-      "name": "Neelima Mohanty",
-      "avatar_url": "https://avatars.githubusercontent.com/u/97789856?v=4",
-      "profile": "https://github.com/neelimagoogly",
-      "contributions": ["doc"]
     }
   ],
   "contributorsPerLine": 7,
-  "linkToUsage": true
+  "linkToUsage": true,
+  "commitType": "docs"
 }
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -0,0 +1,22 @@
+"frontend":
+  - "src/frontend/**/*"
+"backend":
+  - "src/backend/**/*"
+"devops":
+  - ".github/**/*"
+  - "scripts/**/*"
+  - "docker-*.yml"
+  - "**/Dockerfile"
+  - "**/*.dockerfile"
+  - "**/*entrypoint.sh"
+  - "josm/**/*"
+"migration":
+  - "src/backend/migrations/**/*"
+"documentation":
+  - "docs/**/*"
+  - "images/**/*"
+  - "mkdocs.yml"
+  - "README.md"
+  - "INSTALL.md"
+"ODK":
+  - "odkcentral/**/*"
diff --git a/.github/workflows/pr_label.yml b/.github/workflows/pr_label.yml
@@ -0,0 +1,14 @@
+name: PR Label
+
+on:
+  pull_request_target:
+
+jobs:
+  pr-label:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/labeler@v3
+        # Uses .github/labeler.yml definitions
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/pr.yml → .github/workflows/pr_test.yml b/.github/workflows/pr.yml → .github/workflows/pr_test.yml
@@ -1,4 +1,4 @@
-name: PR
+name: PR Tests
 
 on:
   pull_request:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,7 +16,15 @@ Right now, we are in the process of building the prototype. We warmly welcome yo
 
 Create pull requests (PRs) for changes that you think are needed. We would really appreciate your help!
 
-In fact, we are specifically looking for input from developers with **Python skills** and **familiarity with Fast API**.
+Skills with the following would be beneficial:
+- Python
+- FastAPI
+- Javascript
+- React
+- Docker
+- CI/CD workflows
+
+Our latest task board can be found [here](https://github.com/orgs/hotosm/projects/22).
 
 ## Report bugs and suggest improvements
 

diff --git a/INSTALL.md b/INSTALL.md
@@ -22,8 +22,8 @@
 
 Before you can install and use this application, you will need to have the following software installed and configured on your system
 
-- Git(or any other Terminal)
-- Docker
+- [Git(or any other Terminal)](https://git-scm.com/)
+- [Docker](https://docs.docker.com/)
 
 To install Git, please follow the instructions on the official Git website:
 

diff --git a/Makefile b/Makefile
@@ -19,13 +19,14 @@
 # All python source files
 # MDS := $(wildcard ./docs/*.md)
 MDS := \
-	docs/DEV-1.-Getting-Started.md \
-	docs/DEV-2.-Backend.md \
-	docs/DEV-3.-Frontend.md \
-	docs/DEV-4.-Database-Tips.md \
-	docs/DEV-5.-Docker-Tips.md \
-	docs/DEV-6.-Production-Deployment.md \
-	docs/User-Manual-For-Project-Managers.md
+	docs/dev/Backend.md \
+	docs/dev/Database-Tips.md \
+	docs/dev/Deployment-Flow.md \
+	docs/dev/Docker-Tips.md \
+	docs/dev/Frontend.md \
+	docs/dev/Production.md \
+	docs/dev/Setup.md \
+	docs/dev/Troubleshooting.md \
 
 PDFS := $(MDS:.md=.pdf)
 

diff --git a/README.md b/README.md
@@ -22,12 +22,14 @@
 
 🕮 [Documentation](https://hotosm.github.io/fmtm/)
 
-A project to provide tools for Open Mapping campaigns
+🎯 [Task Board](https://github.com/orgs/hotosm/projects/22)
+
+A project to provide tools for Open Mapping campaigns.
 
 While we have pretty good field mapping applications,
 we don’t have great tools to coordinate field mapping.
 However, we have most of the elements needed to create a field mapping-oriented
-version of the HOT Tasking Manager,
+version of the [HOT Tasking Manager](https://tasks.hotosm.org),
 which allows people to select specific areas and
 complete tasks in a coordinated, organized fashion.
 
@@ -68,7 +70,7 @@ To aid future diaster response, we would really welcome developer
 
 ## How to contribute
 
-👍🎉We are actively looking for contributors for this project- from design,
+👍🎉We are actively looking for contributors for this project - from design,
 user testing and both front and backend developers.
 We have a specific request for volunteer developers at the moment!
 ![image](https://user-images.githubusercontent.com/98902727/218812430-3c07b60e-4fd2-4f05-a289-bf37d6f0b9cd.png)
@@ -206,7 +208,7 @@ A computer-screen-optimized web app that allows Campaign Managers to:
 
 - Click on Submit button.
 
-#### FMTM back end
+#### FMTM Backend
 
 A back end that converts the project parameters entered by the Campaign Manager in
 the Manager Web Interface into a corresponding ODK Central project.
@@ -261,24 +263,26 @@ Thanks goes to these wonderful people:
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="http://ivangayton.net"><img src="https://avatars.githubusercontent.com/u/5991943?v=4?s=100" width="100px;" alt="Ivan Gayton"/><br /><sub><b>Ivan Gayton</b></sub></a><br /><a href="#projectManagement-ivangayton" title="Project Management">📆</a> <a href="https://github.com/hotosm/fmtm/commits?author=ivangayton" title="Code">💻</a> <a href="https://github.com/hotosm/fmtm/pulls?q=is%3Apr+reviewed-by%3Aivangayton" title="Reviewed Pull Requests">👀</a> <a href="#ideas-ivangayton" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.hotosm.org"><img src="https://avatars.githubusercontent.com/u/71342768?v=4?s=100" width="100px;" alt="Rob Savoye"/><br /><sub><b>Rob Savoye</b></sub></a><br /><a href="#maintenance-robsavoye" title="Maintenance">🚧</a> <a href="#mentoring-robsavoye" title="Mentoring">🧑‍🏫</a> <a href="https://github.com/hotosm/fmtm/commits?author=robsavoye" title="Code">💻</a> <a href="https://github.com/hotosm/fmtm/pulls?q=is%3Apr+reviewed-by%3Arobsavoye" title="Reviewed Pull Requests">👀</a> <a href="#ideas-robsavoye" title="Ideas, Planning, & Feedback">🤔</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/krtonga"><img src="https://avatars.githubusercontent.com/u/7307817?v=4?s=100" width="100px;" alt="krtonga"/><br /><sub><b>krtonga</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=krtonga" title="Code">💻</a> <a href="https://github.com/hotosm/fmtm/commits?author=krtonga" title="Documentation">📖</a> <a href="#tool-krtonga" title="Tools">🔧</a> <a href="#ideas-krtonga" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/spwoodcock"><img src="https://avatars.githubusercontent.com/u/78538841?v=4?s=100" width="100px;" alt="Sam"/><br /><sub><b>Sam</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=spwoodcock" title="Code">💻</a> <a href="https://github.com/hotosm/fmtm/pulls?q=is%3Apr+reviewed-by%3Aspwoodcock" title="Reviewed Pull Requests">👀</a> <a href="#infra-spwoodcock" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#ideas-spwoodcock" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-spwoodcock" title="Maintenance">🚧</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://www.hotosm.org/people/petya-kangalova/"><img src="https://avatars.githubusercontent.com/u/98902727?v=4?s=100" width="100px;" alt="Petya "/><br /><sub><b>Petya </b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=petya-kangalova" title="Documentation">📖</a> <a href="#eventOrganizing-petya-kangalova" title="Event Organizing">📋</a> <a href="#ideas-petya-kangalova" title="Ideas, Planning, & Feedback">🤔</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/nrjadkry"><img src="https://avatars.githubusercontent.com/u/41701707?v=4?s=100" width="100px;" alt="Niraj Adhikari"/><br /><sub><b>Niraj Adhikari</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=nrjadkry" title="Code">💻</a> <a href="#ideas-nrjadkry" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-nrjadkry" title="Maintenance">🚧</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/varun2948"><img src="https://avatars.githubusercontent.com/u/37866666?v=4?s=100" width="100px;" alt="Deepak Pradhan (Varun)"/><br /><sub><b>Deepak Pradhan (Varun)</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=varun2948" title="Code">💻</a> <a href="#ideas-varun2948" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-varun2948" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/nrjadkry"><img src="https://avatars.githubusercontent.com/u/41701707?v=4?s=100" width="100px;" alt="Niraj Adhikari"/><br /><sub><b>Niraj Adhikari</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=nrjadkry" title="Code">💻</a> <a href="#ideas-nrjadkry" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-nrjadkry" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/krtonga"><img src="https://avatars.githubusercontent.com/u/7307817?v=4?s=100" width="100px;" alt="krtonga"/><br /><sub><b>krtonga</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=krtonga" title="Code">💻</a> <a href="https://github.com/hotosm/fmtm/commits?author=krtonga" title="Documentation">📖</a> <a href="#tool-krtonga" title="Tools">🔧</a> <a href="#ideas-krtonga" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.hotosm.org/people/petya-kangalova/"><img src="https://avatars.githubusercontent.com/u/98902727?v=4?s=100" width="100px;" alt="Petya "/><br /><sub><b>Petya </b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=petya-kangalova" title="Documentation">📖</a> <a href="#eventOrganizing-petya-kangalova" title="Event Organizing">📋</a> <a href="#ideas-petya-kangalova" title="Ideas, Planning, & Feedback">🤔</a></td>
     </tr>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="http://zanrevenue.org"><img src="https://avatars.githubusercontent.com/u/52991565?v=4?s=100" width="100px;" alt="Mohamed Bakari Mohamed"/><br /><sub><b>Mohamed Bakari Mohamed</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Mudi-business" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Sujanadh"><img src="https://avatars.githubusercontent.com/u/109404840?v=4?s=100" width="100px;" alt="Sujan Adhikari"/><br /><sub><b>Sujan Adhikari</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Sujanadh" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/AugustHottie"><img src="https://avatars.githubusercontent.com/u/96122635?v=4?s=100" width="100px;" alt="AugustHottie"/><br /><sub><b>AugustHottie</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=AugustHottie" title="Documentation">📖</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Balofire"><img src="https://avatars.githubusercontent.com/u/102294666?v=4?s=100" width="100px;" alt="Ahmeed Etti-Balogun"/><br /><sub><b>Ahmeed Etti-Balogun</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Balofire" title="Documentation">📖</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Roseford"><img src="https://avatars.githubusercontent.com/u/75838716?v=4?s=100" width="100px;" alt="Uju"/><br /><sub><b>Uju</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Roseford" title="Documentation">📖</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/neelimagoogly"><img src="https://avatars.githubusercontent.com/u/97789856?v=4?s=100" width="100px;" alt="Neelima Mohanty"/><br /><sub><b>Neelima Mohanty</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=neelimagoogly" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://zanrevenue.org"><img src="https://avatars.githubusercontent.com/u/52991565?v=4?s=100" width="100px;" alt="Mohamed Bakari Mohamed"/><br /><sub><b>Mohamed Bakari Mohamed</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Mudi-business" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/NSUWAL123"><img src="https://avatars.githubusercontent.com/u/81785002?v=4?s=100" width="100px;" alt="Nishit Suwal"/><br /><sub><b>Nishit Suwal</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=NSUWAL123" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.scdhub.org"><img src="https://avatars.githubusercontent.com/u/4379874?v=4?s=100" width="100px;" alt="G. Willson"/><br /><sub><b>G. Willson</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=biomassives" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/JoltCode"><img src="https://avatars.githubusercontent.com/u/46378904?v=4?s=100" width="100px;" alt="JoltCode"/><br /><sub><b>JoltCode</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=JoltCode" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/neelimagoogly"><img src="https://avatars.githubusercontent.com/u/97789856?v=4?s=100" width="100px;" alt="Neelima Mohanty"/><br /><sub><b>Neelima Mohanty</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=neelimagoogly" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ndacyayisenga-droid"><img src="https://avatars.githubusercontent.com/u/58124613?v=4?s=100" width="100px;" alt="Tayebwa Noah"/><br /><sub><b>Tayebwa Noah</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Ndacyayisenga-droid" title="Documentation">📖</a></td>
     </tr>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ndacyayisenga-droid"><img src="https://avatars.githubusercontent.com/u/58124613?v=4?s=100" width="100px;" alt="Tayebwa Noah"/><br /><sub><b>Tayebwa Noah</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Ndacyayisenga-droid" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/mohammadareeb95"><img src="https://avatars.githubusercontent.com/u/77102111?v=4?s=100" width="100px;" alt="Mohammad Areeb"/><br /><sub><b>Mohammad Areeb</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=mohammadareeb95" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/AugustHottie"><img src="https://avatars.githubusercontent.com/u/96122635?v=4?s=100" width="100px;" alt="AugustHottie"/><br /><sub><b>AugustHottie</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=AugustHottie" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Balofire"><img src="https://avatars.githubusercontent.com/u/102294666?v=4?s=100" width="100px;" alt="Ahmeed Etti-Balogun"/><br /><sub><b>Ahmeed Etti-Balogun</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Balofire" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Roseford"><img src="https://avatars.githubusercontent.com/u/75838716?v=4?s=100" width="100px;" alt="Uju"/><br /><sub><b>Uju</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Roseford" title="Documentation">📖</a></td>
     </tr>
   </tbody>
   <tfoot>

diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md
@@ -24,4 +24,6 @@
 
 [6. Production Deployment](https://github.com/hotosm/fmtm/wiki/dev/Production)
 
-[7. Troubleshooting](https://github.com/hotosm/fmtm/wiki/dev/Troubleshooting)
+[7. Deployment Flow](https://github.com/hotosm/fmtm/wiki/dev/Deployment-Flow)
+
+[8. Troubleshooting](https://github.com/hotosm/fmtm/wiki/dev/Troubleshooting)