Skip to content

Rov95/splidot

Repository files navigation

Splidot

Splidot is a user-friendly payment manager designed to help you split expenses among friends effortlessly. With Splidot, you can create groups, add expenses, and have the app calculate equal splits for everyone. The app ensures transparency and ease of managing shared costs.

alt text


Getting Started

Prerequisites

To run Splidot locally, you need:

  • Node.js (v16+ recommended)
  • PostgreSQL database
  • A package manager like npm or yarn

Installation

  1. Clone the repository:

    git clone 'https://github.com/Rov95/splidot.git'
    cd splidot
  2. Install dependencies for both the frontend and backend:

    # Install frontend dependencies
    cd client
    npm install
    
    # Install backend dependencies
    cd ../server
    npm install
  3. Configure the environment variables:

    • For the backend, create a .env file in the server directory with the following:
      DATABASE_URL=postgresql://<user>:<password>@localhost:5432/splidot
      PORT=5000
      SESSION_SECRET=<your-secret-key>

Running the Application

  1. Start the backend server:

    cd server
    npm run dev
  2. Start the frontend development server:

    cd ../client
    npm run dev
  3. Open your browser and navigate to http://localhost:3000 to use Splidot.


Tech Stack

Frontend

  • Framework: React with Vite for fast development and build performance
  • Styling: CSS for responsive and modern design

Backend

  • Framework: Node.js with Express for building the server and API
  • Database: PostgreSQL for robust and scalable data management
  • ORM: Sequelize for managing database models and queries
  • Authentication: Session-based authentication for secure user sessions

Contributors

Splidot was developed by:

Contributions, bug reports, and feature requests are welcome! Feel free to open an issue or submit a pull request on GitHub.


About

money manager

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published