Skip to content

swoocn/map-of-pi-redux

Repository files navigation

Map of Pi

Hackathon Status Netlify Status License

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.

Table of Contents

Brand Design

App Logo App Icon
map-of-pi-logo-revised-3 map-of-pi-app-icon-revised-3b-transparent

Tech Stack 📊

  • Frontend: Angular, TypeScript, HTML, SCSS, CSS
  • Backend: Node.js, REST API
  • Database: MongoDB
  • DevOps: GitHub Actions, Netlify

Frontend Local Execution

The Map of Pi Front End Project was generated with Angular CLI V17.1.2.

Build the Project

  • Change directory to front end using cd frontend.
  • Run ng build to build the project.
    • The build artifacts will be stored in the dist/ directory.

Execute the Development Server

  • Change directory to front end using cd frontend.
  • Execute ng serve to spin up a dev server.
  • Navigate to http://localhost:4200/ in your browser.
    • The application will automatically reload if you change any of the source files.

Execute Unit Tests

  • Change directory to front end using cd frontend.
  • Run ng test to execute the unit tests via Karma.

Execute the End-to-End Tests

  • Change directory to front end using cd frontend.
  • Run ng e2e to execute the end-to-end tests via a platform of your choice.
    • To use this command, you need to first add a package that implements end-to-end testing capabilities.

Code Scaffolding

  • Change directory to front end using cd frontend.
  • Run ng generate component [component-name] to generate a new component. - You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Back End Local Execution

Execute the Development Server

  • Change directory to back end using cd backend.
  • Execute npm run start to connect to nodemon and MongoDB server.

Execute Unit Tests

  • Change directory to back end using cd backend.
  • Run npm run test to execute the unit tests via Jest.

Team 🧑👩‍🦱🧔👨🏾‍🦱👨🏾

Project Manager

  • Philip Jennings

Marketing

  • Bonnie Ford
  • Joseph Ciccone

Solution Design / UX

  • Femma Ashraf
  • Oluwabukola Adesina
  • Folorunsho Omotunde

DevOps

  • Danny Lee

Frontend Developers

  • Darin Hajou
  • Zoltan Magyar

Backend Developers

  • Rokundo Soleil

Contributions

We welcome contributions from the community to improve the Map of Pi project.