fhub-1 / invoice

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Invoice

Invoice is a web application for managing and creating invoices. It provides a user-friendly interface to create, view, and manage invoices, making it convenient for businesses to handle their billing process.

Features

  • Create new invoices with item details, quantities, and discounts.
  • View a list of existing invoices with summary information.
  • Click on an invoice to view its details and make updates if needed.
  • Generate printable versions of invoices for record-keeping or sharing.
  • Easily navigate between different sections of the application using the intuitive UI.

Technologies Used

  • Front-end: React, Next.js, Tailwind CSS
  • Database: PostgreSQL
  • Prisma: ORM for database operations

Getting Started

To get started with the Invoice application, follow the instructions below:

  1. Clone the repository:
   git clone https://github.com/fhub-1/invoice.git
  1. Install dependencies:
   
   cd invoice
   npm install
  1. Set up the database:

    • Make sure you have PostgreSQL installed and running on your system.
    • Create a new PostgreSQL database for the Invoice application.
    • Update the database configuration in the .env file.
  2. Run database migrations:

  npx prisma migrate dev
  1. Start the development server:
   npm run dev  
  1. Open your browser and navigate to http://localhost:3000 to access the Invoice application.

Contributing

Contributions to the Invoice project are welcome! If you find a bug or want to suggest an improvement, please create a new issue in the GitHub repository. For code contributions, please follow the standard GitHub workflow of creating a fork, making your changes, and submitting a pull request.

When contributing, please ensure that your code adheres to the existing coding style and conventions. Write clear commit messages and provide a detailed description of the changes you've made.

License

The Invoice application is open-source and released under the MIT License.

Acknowledgements

The Invoice application was developed as part of a coding exercise and serves as a demonstration of skills in web development and database management.

About

License:MIT License


Languages

Language:TypeScript 95.8%Language:JavaScript 3.5%Language:CSS 0.7%