EscrowPi

EscrowPi is a prototype payment solution designed for the Pi Hackathon. It provides a simple escrow-based payment flow that enables secure transactions between buyers and sellers using Pi.

Table of Contents

• Brand Design
• Tech Stack
• Frontend Local Execution
• Team
• Contributions

Brand Design

App Logo	App Icon

Tech Stack 📊

• Frontend: NextJS/ React, TypeScript, Tailwind + MUI
• Backend: Express/ NodeJS, REST API
• Database: MongoDB
• DevOps: GitHub Actions

Project Structure

• src/app/ – App Router pages
• src/components/ – shared UI components
• public/ – static assets

Frontend Local Execution

The EscrowPi Front End is a Next.js project bootstrapped with create-next-app which is a React framework to build web applications. Prerequisite: Node 18+

Install Dependencies

npm install

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:4300/ 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.

Build + Start

npm run build
npm start

Execute Unit Tests

• Run npm run test to execute the unit tests via Jest + Testing Library with jsdom.
• Files:
  • jest.config.ts – Jest configuration (jsdom, ts-jest transform, CSS/file mocks)
  • jest.setup.ts – Testing Library jest-dom setup
  • src/__tests__/smoke.test.tsx – basic smoke test

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

Project Manager

• Philip Jennings

Technical Lead/ DevOps

• Danny Lee

Application Developers

• Yusuf Adisa
• Rajasekhar Reddy

Contributions

We welcome contributions from the community to improve the EscrowPi project.