Skip to content

map-of-pi/map-of-pi-backend-react

Repository files navigation

Map of Pi

Hackathon 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: NextJS/ React, TypeScript, HTML, SCSS, CSS
  • Backend: Express/ NodeJS, REST API
  • Database: MongoDB
  • DevOps: GitHub Actions, Netlify, Vercel

Backend Local Execution

The Map of Pi Back End is a Node.js project.

Build the Project

  • Run npm run build to build the project; compile Typescript into Javascript for production to the .dist folder.
    • The build artifacts are bundled for production mode.

Execute the Development Server

  • Create .env file from the .env.development template and replace placeholders with actual values.
  • Execute npm run dev to connect to nodemon and MongoDB server.
  • Navigate to http://localhost:8001/ in your browser.
  • Execute Frontend Local Execution for integration testing. Alternatively, utilize API tools like Insomnia or Postman to execute the API endpoints.
    • The application will automatically reload if you change any of the source files.
    • For local debugging in VS Code, attach the runtime server to the appropriate Process ID.

Execute Unit Tests

  • 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
  • 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.