Skip to content

Latest commit

 

History

History
97 lines (68 loc) · 3.46 KB

README.md

File metadata and controls

97 lines (68 loc) · 3.46 KB

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-transparent

Tech Stack 📊

  • Frontend: NextJS/ React, TypeScript, HTML, SCSS, CSS
  • Backend: Express/ NodeJS, REST API
  • Database: MongoDB
  • DevOps: GitHub Actions, Netlify, Vercel

Frontend Local Execution

The Map of Pi Front End is a Next.js project bootstrapped with create-next-app which is a React framework to build web applications.

Build the Project

  • Run npm run build to build the project; builds the app for production to the .next folder.
    • The build artifacts are bundled for production mode and optimized for the best performance.

Execute the Development Server

  • Create .env.local file from the .env.development template and replace placeholders with actual values.
  • Execute npm run dev to spin up a dev server.
  • Navigate to http://localhost:4200/ in your browser.
  • Execute Backend Local Execution for integration testing.
    • The application will automatically reload if you change any of the source files.
    • For local debugging in VS Code, attach the runtime server accordingly.
    • Lint errors will be displayed in the console.

Execute Unit Tests

  • Run npm run test to launch the Jest Testing Framework in the interactive watch mode.

Linting the Project

  • Run npm run lint for static code analysis.

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

Project Manager

  • Philip Jennings

Marketing

  • Bonnie Ford
  • Joseph Ciccone

Solution Design / UX

  • Femma Ashraf
  • Oluwabukola Adesina
  • Folorunsho Omotunde
  • Henry Fasakin

Technical Lead/ DevOps

  • Danny Lee

Technical Advisor

  • Zoltan Magyar

Application Developers

  • Darin Hajou
  • Rokundo Soleil
  • Ayomikun Omotosho
  • Yusuf Adisa
  • Francis Mwaura
  • Samuel Oluyomi

Contributions

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