/expenso

Welcome to Expenso, an expense management system designed to help you track and manage your expenses efficiently.

Primary LanguageVueMIT LicenseMIT

Expenso

Welcome to Expenso, an expense management system designed to help you track and manage your expenses efficiently. This repository contains the full codebase for Expenso, organized into two main folders: backend and frontend. Each folder has its own README.md file with specific setup and run instructions.

Admin Panel

image

User Panel

image

Project Structure

  • Backend: Contains the PHP codebase responsible for handling the server-side logic, including API endpoints, database interactions, and authentication. The backend is built using PHP and can be set up to run on a server or locally using tools like Docker.

  • Frontend: Contains the Vue.js codebase responsible for the user interface, where users can input and track their expenses. The frontend is built using modern JavaScript technologies and is designed to provide a seamless user experience.

Getting Started

To set up and run the Expenso project, please follow the instructions provided in the README.md files located within each of the project folders:

Each README.md file contains detailed steps for installing dependencies, configuring the environment, and running the respective part of the project.

Prerequisites

Before setting up Expenso, ensure you have the following installed on your machine:

  • Node.js: Required for running the frontend.
  • PHP: Required for running the backend.
  • Composer: For managing PHP dependencies.
  • Docker: (Optional) If you prefer using Docker for a containerized setup.
  • Git: To clone the repository and manage version control.

Setup Overview

  1. Clone the Repository:

    git clone https://github.com/yourusername/expenso.git
cd expenso

  2. Set Up the Backend: Navigate to the backend folder and follow the instructions in the README.md file to set up the server and database.

  3. Set Up the Frontend: Navigate to the frontend folder and follow the instructions in the README.md file to set up and run the Vue.js application.

  4. Running the Project: After setting up both the backend and frontend, you can start the server and access the application through your browser. Ensure that the backend server is running before you launch the frontend.

Contribution

Contributions are welcome! If you would like to contribute to Expenso, please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.