Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 2.8 KB

README.md

File metadata and controls

107 lines (76 loc) · 2.8 KB

Easy Invoice - Streamlined Invoice Management with Request Network

Easy Invoice is a modern, user-friendly web application that demonstrates the power and simplicity of creating and managing invoices using the Request Network API. Built with Next.js and modern web technologies, this application showcases how easy it is to implement crypto-powered payment solutions in your applications.

✨ Features

  • 🧾 Simple Invoice Creation: Create professional invoices in minutes
  • 💰 Crypto Payments: Accept payments in various cryptocurrencies
  • 🔄 Real-time Updates: Track payment status in real-time
  • 🌐 Web3 Integration: Seamless integration with blockchain technology

🚀 Getting Started

Prerequisites

  • Node.js 18+
  • PostgreSQL database
  • Google OAuth credentials (for authentication)
  • Request Network API key
  • Reown Project ID

Environment Setup

  1. Clone the repository:
git clone [email protected]:RequestNetwork/easy-invoice.git
cd easy-invoice
  1. Copy the environment variables file:
cp .env.example .env
  1. Fill in the required environment variables in .env:
  • DATABASE_URL: Your PostgreSQL connection string
  • GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET: Google OAuth credentials
  • REQUEST_API_KEY: Your Request Network API key
  • REQUEST_API_URL: Request Network API URL
  • NEXT_PUBLIC_REOWN_PROJECT_ID: Your Reown project ID
  • Other required environment variables as specified in .env.example

Installation

  1. Install dependencies:
npm install
# or
yarn install
  1. Set up the database:
# For development:
npm run db:push    # Pushes schema changes directly to the database
# or
yarn db:push

# For production:
npm run db:generate  # Generates migration files based on schema changes
npm run db:migrate   # Applies the generated migrations to the database
# or
yarn db:generate
yarn db:migrate
  1. Start the development server:
npm run dev
# or
yarn dev

The application will be available at http://localhost:3000.

🏗️ Tech Stack

  • Framework: Next.js 14 with App Router
  • Authentication: Google OAuth
  • Database: PostgreSQL with Drizzle ORM
  • Styling: Tailwind CSS
  • State Management: React Query & tRPC
  • Payment Integration: Request Network API
  • Web3: Ethers.js & Viem

📖 Documentation

For more information about the technologies used:

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.