Skip to content

OclaZ/Faturly

Repository files navigation


https://github.com/Oclaz/faturly.git
Next.js PostgreSQL Prisma ORM TailwindCSS Vercel

Faturly - Invoice Management Application

Faturly is a professional invoice application tailored for online businesses, developed with Next.js. It enables businesses to streamline their invoicing processes, generate PDF invoices, and send them via email with ease.

🖥️ Tech Stack

  • Next.js: Framework for fast and dynamic web applications.
  • PostgreSQL: Relational database for managing invoices and user data.
  • Prisma ORM: Type-safe database interaction with PostgreSQL.
  • TailwindCSS: Modern styling for responsive and clean UI.
  • Vercel: Cloud platform for serverless deployment.

📋 Features

  • Authentication: Secure login using Auth.js with Magic Links.
  • PDF Invoicing: Generate professional invoices as PDFs with JsPDF.
  • Email Integration: Send invoices and updates to clients using Mailtrap.
  • Database Management: Store and manage all invoice-related data in PostgreSQL.
  • Overdue Reminders: Automate email reminders for overdue payments.
  • Mobile-Responsive Design: Optimized for all screen sizes and devices.

🚀 Quick Start

Prerequisites

Ensure the following are installed:

  • Git
  • Node.js
  • PostgreSQL

Installation Steps

  1. Clone the Repository:
git clone https://github.com/Oclaz/faturly.git
cd faturly
  1. Install Dependencies:
npm install
  1. Set Up Environment Variables: Create a .env file in the root directory and add the following:
DATABASE_URL=your_postgres_database_url
MAILTRAP_API_KEY=your_mailtrap_api_key
NEXTAUTH_SECRET=your_auth_secret
  1. Run Database Migrations:
npx prisma migrate dev
  1. Start the Development Server:
npm run dev

Visit http://localhost:3000 to access the app.

📁 Folder Structure

├── components       # Reusable UI components
├── pages           # Next.js pages and API routes
├── prisma          # Database schema and migrations
├── public          # Static assets (e.g., logo.svg)
├── styles          # TailwindCSS global styles
└── utils           # Helper functions (e.g., email services)

📱 Contact

For inquiries or support, feel free to reach out to Oclaz or open an issue in the repository.

Built with ❤️ by Oclaz

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages