Invoice System README

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup Instructions
  • Prerequisites
  • Screenshots
  • APK Download link
  • Appetize showcase
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Invoice System

Invoice System is a mobile app that integrates with an M-Pesa payment API to generate and process invoices.

🛠 Built With

Tech Stack

Backend

• Laravel

Frontend

• Flutter

Key Features

• Invoice Generation
• M-Pesa Payment Processing
• Transaction History Display

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project, you need the following:

• Visual Studio Code IDE
• Flutter SDK
• PHP 5.6 or higher
• Composer

Setup Instructions

Backend

1. Clone the repository: git clone https://github.com/AsciencioAlex/Invoice-System.git
2. Navigate to the project directory: cd Invoice-System/invoice-backend
3. Install dependencies: composer install
4. Create a copy of .env.example and rename it to .env: cp .env.example .env
5. Generate an application key: php artisan key:generate
6. Configure your .env file with the appropriate database and M-Pesa API credentials.
7. Run the migrations: php artisan migrate
8. Start the development server: php artisan serve

Frontend

1. Clone the repository: git clone https://github.com/AsciencioAlex/Invoice-System.git
2. Navigate to the project directory: cd Invoice-System/invoice_frontend
3. Install dependencies: flutter pub get
4. Run the app on an emulator or physical device: flutter run

(back to top)

👥 Authors

👤 Your Name

• GitHub: @AsciencioAlex
• LinkedIn: Alex Asciencio

(back to top)

🔭 Future Features

• Additional payment methods
• Detailed transaction reports
• Multi-currency support

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, feel free to clone it and incorporate features that enhance your own projects.

(back to top)

🙏 Acknowledgements

I thank all contributors and the open-source community for their support.

(back to top)

❓ FAQ

• Can I run the project without installing on the terminal?

  • Yes, you can run it directly on the browser using Flutter Web.

• Can I build such a page from scratch and where can I learn?

  • Yes, it's possible. You can start by learning Flutter and Laravel from their official documentation.

(back to top)

📝 License

This project is MIT licensed.

(back to top)