Skip to content

Programmable payroll app to automate payments and track payments

License

Notifications You must be signed in to change notification settings

ceeriil/paystream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

๐Ÿš€ Paystream

Programmable payroll app to automate payments and track payments using Streamflow.

๐ŸŽฅ Demo

Watch the demo

โœจ Features (MVP)

  • โœ… Automate payments via Streamflow
  • โœ… Track and manage payments
  • โœ… Add and manage employees
  • โœ… Use on TestNet or DevNet (support for USDC only for now)
  • โœ… Secure and transparent transaction history
  • โœ… View Contract details and some stats
  • โœ… Smart accounts - log in with socials and fund wallet

๐Ÿ”ฎ Future Enhancements

  • ๐Ÿš€ Multi-chain support for payments
  • ๐Ÿš€ Multi-token (this is already set up)
  • ๐Ÿš€ Advanced analytics and reporting

โšก Tech Stack


๐Ÿ› ๏ธ Getting Started

๐Ÿฐ Installation

Clone the repository and install dependencies:

git clone https://github.com/ceeriil/paystream.git
cd paystream
yarn install

๐Ÿš€ Running the Project

yarn dev     # Start development server
yarn build   # Build for production
yarn start   # Run the production build

๐Ÿ”ง Environment Variables Setup

Before running the project, you need to set up your environment variables.

  1. Copy .env.example to .env or .env.local:

    cp .env.example .env
  2. Populate the environment variables with the necessary credentials:

    • Reown Project ID: To get a NEXT_PUBLIC_PROJECT_ID, go to Reown, create a project, and obtain the project ID.
    • Helius RPC: Obtain your Helius RPC URL by creating an account on Helius and generating an RPC endpoint. Alternatively, you can use another Solana RPC provider.
    • Firebase Config: Get your Firebase environment variables by creating a project on Firebase. If you are working in a test or development environment, you can use the Firebase emulator instead.

๐Ÿ“ Environment Variables File (.env)

NEXT_PUBLIC_PROJECT_ID="reown project id"
NEXT_PUBLIC_HELIUS_MAINNET_RPC=""
NEXT_PUBLIC_HELIUS_DEVNET_RPC=""
NEXT_PUBLIC_ETH_ALCHEMY_SEPOLIA_RPC=""
NEXT_PUBLIC_ETH_ALCHEMY_MAINNET_RPC=""

NEXT_PUBLIC_FIREBASE_API_KEY=""
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=""
NEXT_PUBLIC_FIREBASE_PROJECT_ID=""
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=""
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=""
NEXT_PUBLIC_FIREBASE_APP_ID=""
GOOGLE_APPLICATION_CREDENTIALS=""
FIREBASE_SERVICE_ACCOUNT_KEY=""

If you encounter any issues, feel free to contact me for support.

About

Programmable payroll app to automate payments and track payments

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages