Skip to content

map-of-pi/escrow-pi-backend

Repository files navigation

EscrowPi

Hackathon Status License

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

App Logo App Icon
escrow-pi-logo escrow-pi-logo

Tech Stack 📊

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

Backend Local Execution

The EscrowPi 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

Technical Lead/ DevOps

  • Danny Lee

Application Developers

  • Yusuf Adisa
  • Rajasekhar Reddy

Contributions

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

About

Escrow Pi Backend NodeJS Codebase

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5