diff --git a/README.md b/README.md index 8ae5f05..3ed9f19 100644 --- a/README.md +++ b/README.md @@ -1 +1,35 @@ -# KOS +# Vell Invoicing and Financial Management System + +Vell is a comprehensive invoicing and financial management system designed to help you run your business smoothly. It includes modules for managing customers, products, invoices, and staff, as well as a dashboard to give you a high-level overview of your business. + +## Features + +* **Dashboard:** Get a quick overview of your business with key metrics like total revenue and outstanding invoices. +* **Customer Management (CRM):** Manage all your customer information in one place. +* **Product Management:** Keep track of your products and services. +* **Invoice Management:** Create, send, and track professional invoices. +* **Staff Management:** Manage your team members and their roles. +* **Company Management:** Keep your company information up to date. + +## Getting Started + +To get started with Vell, you'll need to have Python and Django installed on your system. + +1. **Clone the repository:** + ``` + git clone https://github.com/your-username/vell.git + ``` +2. **Install the dependencies:** + ``` + pip install -r requirements.txt + ``` +3. **Run the migrations:** + ``` + python manage.py migrate + ``` +4. **Start the development server:** + ``` + python manage.py runserver + ``` + +You can then access the application at `http://localhost:8000`. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..668bc5f --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +asgiref==3.10.0 +Django==5.2.8 +greenlet==3.2.4 +pillow==12.0.0 +playwright==1.55.0 +pyee==13.0.0 +sqlparse==0.5.3 +typing_extensions==4.15.0