Skip to content

Latest commit

 

History

History
102 lines (67 loc) · 2.58 KB

README.md

File metadata and controls

102 lines (67 loc) · 2.58 KB
Raw

Settle It

Blend in the fun and let us handle your expenses.

License: MIT

Expenses Tracker

Introduction

Features

  • Expense Tracking: Easily record and categorize expenses during trips or outings.
  • Expense Splitting: Automatically split expenses among participants and ensure fairness.
  • Real-time Updates: View and manage expenses with real-time updates.
  • User-friendly Interface: Intuitive design for easy navigation and use.

Technology Stack

  • Frontend: NextJS, TypeScript
  • Backend NextJS API Routes
  • Styling: SASS
  • Database: MongoDB

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js (>= 18.x)
  • yarn

Installation

  1. Clone the repository:

    git clone https://github.com/akshatmittal61/settle-it.git
cd settle-it

  2. Install dependencies:

    yarn

  3. Start the development server:

    yarn dev

  4. Open your browser and navigate to:

    http://localhost:3000

Contributing

We welcome contributions to Settle It! Here’s how you can help:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature-name)
  3. Make your changes and commit them (git commit -am 'Add your feature')
  4. Push to the branch (git push origin feature/your-feature-name)
  5. Create a new Pull Request

License

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

Acknowledgments

  • Special thanks to all contributors and the open-source community for their support.
  • Inspired by the need for simple and efficient expense management during group activities.

Contact

For any questions or feedback, please open an issue in the repository or reach out to us at [email protected].

Author

Akshat Mittal

Acknowledgements