Issue/283

CONTRIBUTING.md

@@ -1,5 +1,14 @@
 # Contributing to World Cleanup Day App and Platform
 
+Not sure how to start? Read on for the general process or [jump right in](GETTING_STARTED.md).
+
+- [Code of Conduct](#code-of-conduct)
+- [How can you contribute?](#how-you-can-contribute)
+- [Issue Contributions](#issue-contributions)
+- [Code Contributions](#code-contributions)
+- [Additional Notes](#additional-notes)
+- [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin-11)
+
 ## Code of Conduct
 
 * We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic.
@@ -13,7 +22,7 @@
 * Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.
 * Avoid the use of personal pronouns in code comments or documentation. There is no need to address persons when explaining code (e.g. "When the developer").
 
-## How you can contribute? 
+## How you can contribute?
 Do you like to design?
 
 * Create art for social media banners to promote the project

GETTING_STARTED.md

@@ -0,0 +1,38 @@
+# Getting started
+
+This document will help you set up the project for development.
+
+## Basic dependencies
+Install git, docker, docker-compose, node and yarn.
+
+
+## Backend services
+Consult the dedicated [readme](devops/dev/README.md) to set them up, run
+them and verify they work.
+
+### Adding dummy data
+This repository comes without trashpoint data. You will need some to work
+on the related APIS or marker related functionality.
+
+**TODO:** expand with wcd_dummy instructions
+
+
+## Web-app (admin backend)
+Consult the dedicated [readme](web-app/README.md), but in essence:
+
+```bash
+npm install # the first time
+npm start
+```
+
+## Mobile-apps
+Consult the dedicated [readme](mobile-app/README.md).
+
+
+## Extra reading
+
+* [Contributing](./CONTRIBUTING.md) to World Cleanup Day App and Platform
+* [Code of Conduct](./CODE_OF_CONDUCT.md)
+* [Governance](./GOVERNANCE.md)
+* [Roadmap](./ROADMAP.md)
+* Issues marked [good first issue](https://github.com/letsdoitworld/World-Cleanup-Day/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

README.md

@@ -3,7 +3,7 @@
 
 [![Join the chat at https://gitter.im/letsdoitworld/World-Cleanup-Day](https://badges.gitter.im/letsdoitworld/World-Cleanup-Day.svg)](https://gitter.im/letsdoitworld/World-Cleanup-Day?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-Over 17 million trash heroes have already cleaned up more than 500 000 tonnes of trash in over 100 countries! The movement against pollution is growing fast and we're now building the World Cleanup App and Platform for the hundreds of millions of people people joining the World Cleanup Day on **15th of September 2018**. 
+Over 20 million trash heroes have already cleaned up more than 500 000 tonnes of trash in over 100 countries! The movement against pollution is growing fast and we're now building the World Cleanup App and Platform for the hundreds of millions of people people joining the World Cleanup Day on **15th of September 2018**. 
 
 Together we will get rid of trash once and for all, save lives, improve health & reduce costs. Read below on how you can participate! Let's do it! 😃 
 
@@ -43,6 +43,9 @@ Join the movement and let's clean up the World together!
 ## API
 See the [API docs](http://ldiw-api.s3-website.eu-central-1.amazonaws.com/)
 
+## Translations
+See [translate.worldcleanupday.org](https://translate.worldcleanupday.org/ )
+
 ## Roadmap
 See [Roadmap.md](https://github.com/letsdoitworld/World-Cleanup-Day/blob/master/ROADMAP.md)
 

backend-api/api/controllers/teams.js

@@ -0,0 +1,28 @@
+'use strict';
+const senecaRequestMw = require('../../modules/swagger-setup/middleware/seneca');
+
+module.exports = {
+    getAllTeams: senecaRequestMw(
+        'role:db,cmd:getAllTeams',
+        req => ({
+            CC: req.swagger.params.country.value,
+            search: req.swagger.params.search.value,
+        }),
+    ),
+    getAllTeamsWeb: senecaRequestMw(
+        'role:db,cmd:getAllTeamsWeb',
+        req => ({
+            CC: req.swagger.params.country.value,
+            superadmin: req.swagger.params.superadmin.value,
+        }),
+    ),
+    getCountTeamsTrashpoints: senecaRequestMw(
+        'role:db,cmd:getCountTeamsTrashpoints',
+    ),
+    getTeam: senecaRequestMw(
+        'role:db,cmd:getTeam',
+        req => ({
+            id: req.swagger.params.id.value,
+        }),
+    )
+};

backend-api/api/controllers/users.js

@@ -17,6 +17,12 @@ module.exports = {
             update: req.swagger.params.update.value,
         }),
     ),
+    modifyUserTeam: senecaRequestMw(
+      'role:db,cmd:modifyOwnUserProfile',
+      req => ({
+        update: req.swagger.params.update.value,
+      }),
+    ),
     getUserProfile: senecaRequestMw(
         'role:db,cmd:getAccountById',
         req => ({

backend-api/api/v1.0.yaml

@@ -68,6 +68,22 @@ paths:
         "default":
           $ref: "#/responses/ErrorSet"
   #-----------------------------------------------------------------------------
+  /me/team:
+    x-swagger-router-controller: users
+    put:
+      description: Join user to team.
+      operationId: modifyUserTeam
+      x-security: [bearer]
+      parameters:
+        - $ref: "#/parameters/ModifyTeam"
+      responses:
+        "200":
+          description: Account information.
+          schema:
+            $ref: "#/definitions/Account"
+        "default":
+          $ref: "#/responses/ErrorSet"
+  #-----------------------------------------------------------------------------
   /auth/external:
     x-swagger-router-controller: users
     post:
@@ -193,6 +209,58 @@ paths:
         "default":
           $ref: "#/responses/ErrorSet"
   #-----------------------------------------------------------------------------
+  /teams:
+    x-swagger-router-controller: teams
+    get:
+      description: List all teams.
+      operationId: getAllTeams
+      parameters:
+        - $ref: "#/parameters/Country"
+        - $ref: "#/parameters/Search"
+      responses:
+        "200":
+          $ref: "#/responses/Teams"
+        "default":
+          $ref: "#/responses/ErrorSet"
+  /teams/web:
+    x-swagger-router-controller: teams
+    get:
+      description: List all teams attached to this admin.
+      operationId: getAllTeamsWeb
+      x-security: [bearer, {roles:[superadmin, leader]}]
+      parameters:
+        - $ref: "#/parameters/Country"
+        - $ref: "#/parameters/Superadmin"
+      responses:
+        "200":
+          $ref: "#/responses/Teams"
+        "default":
+          $ref: "#/responses/ErrorSet"
+  /teams/trashpoints:
+    x-swagger-router-controller: teams
+    get:
+      description: Fetch information about trashpoints for all teams.
+      operationId: getCountTeamsTrashpoints
+      responses:
+        "200":
+          $ref: "#/responses/Teams"
+        "default":
+          $ref: "#/responses/ErrorSet"
+  /teams/{id}:
+    x-swagger-router-controller: teams
+    get:
+      description: Fetch complete info about a specific team.
+      operationId: getTeam
+      parameters:
+        - $ref: "#/parameters/UUID"
+      responses:
+        "200":
+          description: Full team information.
+          schema:
+            $ref: "#/definitions/Team"
+        "default":
+          $ref: "#/responses/ErrorSet"
+  #-----------------------------------------------------------------------------
   /areas/user:
     x-swagger-router-controller: areas
     get:
@@ -541,6 +609,20 @@ parameters:
     minLength: 3
     maxLength: 10
   #-----------------------------------------------------------------------------
+  Search:
+    name: search
+    in: query
+    required: false
+    type: string
+    minLength: 3
+    maxLength: 60
+  #-----------------------------------------------------------------------------
+  Superadmin:
+    name: superadmin
+    in: query
+    required: false
+    type: boolean
+  #-----------------------------------------------------------------------------
   Country:
     name: country
     in: query
@@ -559,6 +641,17 @@ parameters:
         country:
           $ref: "#/definitions/CountryCode"
   #-----------------------------------------------------------------------------
+  ModifyTeam:
+    name: update
+    in: body
+    required: true
+    schema:
+      type: object
+      required: [team]
+      properties:
+        team:
+          $ref: "#/definitions/UUID"
+  #-----------------------------------------------------------------------------
   ModifyTrashpoint:
     name: trashpoint
     in: body
@@ -677,6 +770,12 @@ responses:
     description: List of trashpoints for area leader consumption.
     schema:
       $ref: "#/definitions/PaginatedAreaTrashpoints"
+  Teams:
+    description: List of teams.
+    schema:
+      type: array
+      items:
+        $ref: "#/definitions/Team"
   StorageAuth:
     description: A short-term authorization allowing access to storage operations.
     schema:
@@ -720,6 +819,28 @@ definitions:
         description: Area can be optionally be assigned to a user.
         $ref: "#/definitions/UUID"
   #-----------------------------------------------------------------------------
+  # Team properties.
+  #-----------------------------------------------------------------------------
+  Team:
+    type: object
+    required: [id, name]
+    properties:
+      id:
+        description: A unique code of team
+        type: string
+      name:
+        description: A name of team
+        type: string
+      teamDescription:
+        description: Desctiption of team
+        type: string
+      trashpoints:
+        description: How many trashpoints have this team
+        type: integer
+      users:
+        description: How many users have this team
+        type: integer
+  #-----------------------------------------------------------------------------
   # Account properties.
   #-----------------------------------------------------------------------------
   Account:
@@ -743,6 +864,10 @@ definitions:
         $ref: "#/definitions/ISOTimestamp"
       locked:
         type: boolean
+      team:
+        type:
+          - string
+          - 'null'
   AccountPlusAreas:
     allOf:
     - "$ref": "#/definitions/Account"

backend-api/modules/swagger-setup/middleware/security.js

@@ -72,7 +72,7 @@ const bearerCheck = async (req, res, next) => {
         if (response.isSuccessful()) {
             const ret = response.getPayload();
             req.__.user = util.object.filter(ret.account, {
-                id: true, termsAcceptedAt: true, role: true,
+                id: true, termsAcceptedAt: true, role: true, team: true
             });
             req.__.session = ret.session;
             return next();