├── .env.development
├── .github
└── workflows
│ ├── build.yml
│ └── merge.yml
├── .gitignore
├── .sentryclirc
├── .vscode
└── launch.json
├── LICENSE
├── README.md
├── jest.config.js
├── package-lock.json
├── package.json
├── src
├── config
│ ├── dbConnection.ts
│ ├── docs
│ │ ├── MapCenterSchema.yml
│ │ ├── ReportsSchema.yml
│ │ ├── ReviewFeedbackSchema.yml
│ │ ├── SellersItemSchema.yml
│ │ ├── SellersSchema.yml
│ │ ├── TogglesSchema.yml
│ │ ├── UserPreferencesSchema.yml
│ │ ├── UsersSchema.yml
│ │ └── enum
│ │ │ ├── DeviceLocationType.yml
│ │ │ ├── FulfillmentType.yml
│ │ │ ├── RatingScale.yml
│ │ │ ├── SellerType.yml
│ │ │ ├── StockLevelType.yml
│ │ │ └── TrustMeterScale.yml
│ ├── loggingConfig.ts
│ ├── platformAPIclient.ts
│ ├── sentryConnection.ts
│ └── swagger.ts
├── controllers
│ ├── admin
│ │ ├── reportsController.ts
│ │ ├── restrictionController.ts
│ │ └── toggleController.ts
│ ├── mapCenterController.ts
│ ├── reviewFeedbackController.ts
│ ├── sellerController.ts
│ ├── userController.ts
│ └── userPreferencesController.ts
├── cron
│ ├── index.ts
│ ├── jobs
│ │ └── sanctionBot.job.ts
│ └── utils
│ │ ├── geoUtils.ts
│ │ └── sanctionUtils.ts
├── helpers
│ ├── imageUploader.ts
│ ├── jwt.ts
│ └── location.ts
├── index.ts
├── middlewares
│ ├── isPioneerFound.ts
│ ├── isSellerFound.ts
│ ├── isToggle.ts
│ ├── isUserSettingsFound.ts
│ ├── logger.ts
│ └── verifyToken.ts
├── models
│ ├── ReviewFeedback.ts
│ ├── Seller.ts
│ ├── SellerItem.ts
│ ├── User.ts
│ ├── UserSettings.ts
│ ├── enums
│ │ ├── deviceLocationType.ts
│ │ ├── fulfillmentType.ts
│ │ ├── ratingScale.ts
│ │ ├── restrictedArea.ts
│ │ ├── sellerType.ts
│ │ ├── stockLevelType.ts
│ │ └── trustMeterScale.ts
│ └── misc
│ │ ├── SanctionedRegion.ts
│ │ └── Toggle.ts
├── routes
│ ├── home.routes.ts
│ ├── index.ts
│ ├── mapCenter.routes.ts
│ ├── report.routes.ts
│ ├── restriction.routes.ts
│ ├── reviewFeedback.routes.ts
│ ├── seller.routes.ts
│ ├── toggle.routes.ts
│ ├── user.routes.ts
│ └── userPreferences.routes.ts
├── services
│ ├── admin
│ │ ├── report.service.ts
│ │ ├── restriction.service.ts
│ │ └── toggle.service.ts
│ ├── mapCenter.service.ts
│ ├── misc
│ │ └── image.service.ts
│ ├── reviewFeedback.service.ts
│ ├── seller.service.ts
│ ├── user.service.ts
│ └── userSettings.service.ts
├── types.ts
└── utils
│ ├── app.ts
│ ├── cloudinary.ts
│ ├── env.ts
│ └── multer.ts
├── test
├── controllers
│ ├── admin
│ │ ├── reportsController.spec.ts
│ │ ├── restrictionController.spec.ts
│ │ └── toggleController.spec.ts
│ ├── mapCenterController.spec.ts
│ ├── reviewFeedbackController.spec.ts
│ ├── sellerController.spec.ts
│ └── userController.spec.ts
├── cron
│ ├── job
│ │ └── sanctionBot.job.spec.ts
│ └── utils
│ │ ├── geoUtils.spec.ts
│ │ └── sanctionUtils.spec.ts
├── helpers
│ └── location.spec.ts
├── jest.setup.ts
├── middlewares
│ ├── isToggle.spec.ts
│ └── verifyToken.spec.ts
├── mockData.json
├── routes
│ └── home.routes.spec.ts
└── services
│ ├── admin
│ ├── report.service.spec.ts
│ ├── restriction.service.spec.ts
│ └── toggle.service.spec.ts
│ ├── mapCenter.service.spec.ts
│ ├── reviewFeedback.service.spec.ts
│ ├── seller.service.spec.ts
│ └── userSettings.service.spec.ts
├── tsconfig.json
└── vercel.json
/.env.development:
--------------------------------------------------------------------------------
1 | # The .env.development file is a template for environment variables.
2 | # Only add new variables or update existing ones here, but DO NOT include actual values.
3 | # Use placeholders in the form of "ADD YOUR $" where $ represents the purpose of the variable.
4 | # Your environment-specific values should be set in your .env.local file, which is not tracked in version control.
5 |
6 | NODE_ENV=development
7 | JWT_SECRET=MAP_OF_PI
8 | PLATFORM_API_URL=https://api.minepi.com
9 | PI_API_KEY="ADD YOUR PI API KEY"
10 | ADMIN_API_USERNAME="ADD YOUR ADMIN API USERNAME"
11 | ADMIN_API_PASSWORD="ADD YOUR ADMIN API PASSWORD"
12 |
13 | MONGODB_URL=mongodb://localhost:27017/demoDB
14 | MONGODB_MIN_POOL_SIZE=1
15 | MONGODB_MAX_POOL_SIZE=5
16 |
17 | SENTRY_DSN="ADD YOUR SENTRY DSN"
18 |
19 | PORT=8001
20 | UPLOAD_PATH=../../tmp/uploads
21 |
22 | CLOUDINARY_CLOUD_NAME="ADD YOUR CLOUDINARY CLOUD NAME"
23 | CLOUDINARY_API_KEY="ADD YOUR CLOUDINARY API KEY"
24 | CLOUDINARY_API_SECRET="ADD YOUR CLOUDINARY API SECRET"
25 |
26 | DEVELOPMENT_URL=http://localhost:8001
27 | PRODUCTION_URL=https://map-of-pi-backend-react.vercel.app/
28 | CORS_ORIGIN_URL=http://localhost:4200
29 |
--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
1 | name: Map of Pi Build
2 |
3 | # Controls when the workflow will execute
4 | on:
5 | # Triggers the workflow on push or pull request events for the "main" and "dev" branch
6 | push:
7 | branches:
8 | - main
9 | - dev
10 | pull_request:
11 | branches:
12 | - main
13 | - dev
14 |
15 | # Allows you to run this workflow manually from the Actions tab
16 | workflow_dispatch:
17 |
18 | jobs:
19 | build:
20 | name: 🏗️ Build
21 | runs-on: ubuntu-latest
22 | # The sequence of tasks that will be executed as part of the job
23 | steps:
24 | - name: Checkout code
25 | uses: actions/checkout@v3
26 |
27 | - name: Install Node
28 | uses: actions/setup-node@v3
29 | with:
30 | node-version: 18.x
31 |
32 | # Backend CI/CD Process
33 | - name: Install Dependencies for Backend
34 | run: npm ci
35 |
36 | - name: Execute Tests for Backend
37 | run: npm run test -- --passWithNoTests
38 |
--------------------------------------------------------------------------------
/.github/workflows/merge.yml:
--------------------------------------------------------------------------------
1 | name: Map of Pi Merge
2 |
3 | # Controls when the workflow will execute
4 | on:
5 | # Triggers the workflow when build successfully completes
6 | workflow_run:
7 | workflows: ["Map of Pi Build"]
8 | types:
9 | - completed
10 |
11 | # Allows you to run this workflow manually from the Actions tab
12 | workflow_dispatch:
13 |
14 | jobs:
15 | merge:
16 | name: 🔀 Merge
17 | runs-on: ubuntu-latest
18 | if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_branch == 'dev' }}
19 |
20 | # The sequence of tasks that will be executed as part of the job
21 | steps:
22 | - name: Checkout code
23 | uses: actions/checkout@v3
24 |
25 | - name: Merge dev to main
26 | uses: repo-sync/pull-request@v2
27 | with:
28 | github_token: ${{ secrets.GITHUB_TOKEN }}
29 | source_branch: "dev"
30 | destination_branch: "main"
31 | pr_title: "Automated PR to merge dev to main"
32 | pr_body: ":robot: Automated PR from **dev** to **main**; see commits."
33 | pr_label: "auto-pr"
34 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # Compiled output
4 | /dist
5 |
6 | # dependencies
7 | /node_modules
8 |
9 | # testing
10 | /coverage
11 |
12 | # local env files
13 | .env
14 | .vercel
15 |
16 | # local misc
17 | uploads
18 | /scripts
19 |
--------------------------------------------------------------------------------
/.sentryclirc:
--------------------------------------------------------------------------------
1 |
2 | [auth]
3 | token=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
4 |
--------------------------------------------------------------------------------
/.vscode/launch.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "0.2.0",
3 | "configurations": [
4 | {
5 | "name": "Debug Jest Tests",
6 | "type": "node",
7 | "request": "launch",
8 | "program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
9 | "args": [
10 | "--runInBand",
11 | "--config",
12 | "${workspaceFolder}/jest.config.js",
13 | "--verbose"
14 | ],
15 | "console": "integratedTerminal",
16 | "internalConsoleOptions": "neverOpen",
17 | "env": {
18 | "NODE_ENV": "test"
19 | }
20 | },
21 | {
22 | "name": "Attach by Process ID",
23 | "processId": "${command:PickProcess}",
24 | "request": "attach",
25 | "type": "node"
26 | }
27 | ]
28 | }
29 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | PiOS License
2 |
3 | Copyright (C) 2024 Map Of Pi Team
4 |
5 | Permission is hereby granted by the application software developer (“Software Developer”), free
6 | of charge, to any person obtaining a copy of this application, software and associated
7 | documentation files (the “Software”), which was developed by the Software Developer for use on
8 | Pi Network, whereby the purpose of this license is to permit the development of derivative works
9 | based on the Software, including the right to use, copy, modify, merge, publish, distribute,
10 | sub-license, and/or sell copies of such derivative works and any Software components incorporated
11 | therein, and to permit persons to whom such derivative works are furnished to do so, in each case,
12 | solely to develop, use and market applications for the official Pi Network. For purposes of this
13 | license, Pi Network shall mean any application, software, or other present or future platform
14 | developed, owned or managed by Pi Community Company, and its parents, affiliates or subsidiaries,
15 | for which the Software was developed, or on which the Software continues to operate. However,
16 | you are prohibited from using any portion of the Software or any derivative works thereof in any
17 | manner (a) which infringes on any Pi Network intellectual property rights, (b) to hack any of Pi
18 | Network’s systems or processes or (c) to develop any product or service which is competitive with
19 | the Pi Network.
20 |
21 | The above copyright notice and this permission notice shall be included in all copies or
22 | substantial portions of the Software.
23 |
24 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
25 | INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
26 | AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS, PUBLISHERS, OR COPYRIGHT HOLDERS OF THIS
27 | SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL
28 | DAMAGES (INCLUDING, BUT NOT LIMITED TO BUSINESS INTERRUPTION, LOSS OF USE, DATA OR PROFITS)
29 | HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
30 | TORT (INCLUDING NEGLIGENCE) ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
31 | OR OTHER DEALINGS IN THE SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
32 |
33 | Pi, Pi Network and the Pi logo are trademarks of the Pi Community Company.
34 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Map of Pi
2 |
3 |
4 |
5 | [](https://github.com/pi-apps/PiOS/blob/main/pi-commerce.md)
6 | 
7 | 
8 |
9 |
10 |
11 |
12 |
Map of Pi is a mobile application developed to help Pi community members easily locate local businesses that accept Pi as payment. This project was initiated as part of the Pi Commerce Hackathon with the goal of facilitating Pi transactions and connecting businesses with the Pi community.
13 |
| 
28 |
29 | ## Tech Stack 📊
30 |
31 | - **Frontend**: NextJS/ React, TypeScript, HTML, SCSS, CSS
32 | - **Backend**: Express/ NodeJS, REST API
33 | - **Database**: MongoDB
34 | - **DevOps**: GitHub Actions, Netlify, Vercel
35 |
36 | ## Backend Local Execution
37 |
38 | The Map of Pi Back End is a [Node.js](https://nodejs.org/) project.
39 |
40 | ### Build the Project
41 |
42 | - Run `npm run build` to build the project; compile Typescript into Javascript for production to the `.dist` folder.
43 | - The build artifacts are bundled for production mode.
44 |
45 | ### Execute the Development Server
46 |
47 | - Create .env file from the .env.development template and replace placeholders with actual values.
48 | - Execute `npm run dev` to connect to nodemon and MongoDB server.
49 | - Navigate to http://localhost:8001/ in your browser.
50 | - Execute **[Frontend Local Execution](https://github.com/map-of-pi/map-of-pi-frontend-react/blob/dev/README.md#frontend-local-execution)** for integration testing. Alternatively, utilize API tools like Insomnia or Postman to execute the API endpoints.
51 | - The application will automatically reload if you change any of the source files.
52 | - For local debugging in VS Code, attach the runtime server to the appropriate Process ID.
53 |
54 | ### Execute Unit Tests
55 |
56 | - Run `npm run test` to execute the unit tests via [Jest](https://jestjs.io/).
57 |
58 | ## Team 🧑👩🦱🧔👨🏾🦱👨🏾
59 |
60 | ### Project Manager
61 | - Philip Jennings
62 |
63 | ### Marketing
64 | - Bonnie Ford
65 | - Joseph Ciccone
66 |
67 | ### Solution Design / UX
68 | - Femma Ashraf
69 | - Oluwabukola Adesina
70 | - Folorunsho Omotunde
71 | - Henry Fasakin
72 |
73 | ### Technical Lead/ DevOps
74 | - Danny Lee
75 |
76 | ### Technical Advisor
77 | - Zoltan Magyar
78 |
79 | ### Application Developers
80 | - Darin Hajou
81 | - Rokundo Soleil
82 | - Ayomikun Omotosho
83 | - Yusuf Adisa
84 | - Francis Mwaura
85 | - Samuel Oluyomi
86 |
87 | ## Contributions
88 |
89 |
90 |
We welcome contributions from the community to improve the Map of Pi project.
91 |