Giter Site home page Giter Site logo

paye-backend's Introduction

Paye

Paye is a simple and intuitive expense-tracking application designed to help users manage shared expenses in various scenarios such as living with roommates or going on trips with family and friends.

Features

  • User Management:

    • Create user accounts with unique usernames and email addresses.
    • Securely store user passwords using password hashing.
  • Group Management:

    • Create groups for different expense scenarios (e.g., Roommates, Trip with Family).
    • Easily add and remove users from groups.
  • Expense Tracking:

    • Record expenses with details such as amount, description, category, and date.
    • Support for splitting expenses among group members.
  • Real-Time Updates:

    • Get real-time updates on expenses and balances.
    • Receive push notifications for new expenses and settlements.

Getting Started

  1. Clone the Repository:

    git clone https://github.com/utsav82/Paye-Backend/
    cd Paye-Backend
  2. Install Dependencies:

    npm install
  3. Configure Database:

    • Set up your MongoDB connection string in the .env file.
    • MONGO_URL=""
    • SECRET=""
  4. Run the Application:

    npm start
  5. API Endpoints:

    • User-related endpoints: /users
    • Group-related endpoints: /groups
    • Expense-related endpoints: /expenses
    • User-Group relationship endpoints: /usergroup
    • Expense-Share relationship endpoints: /expenseshare

API Documentation

For detailed API documentation and usage examples, refer to the API Documentation.

Technologies Used

  • Node.js
  • Express.js
  • MongoDB
  • Mongoose

To-Do List

  • Implement email verification for new user accounts.
  • Enhance schema.
  • Improve error handling and validation.

Contributing

We welcome contributions! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request.


paye-backend's People

Contributors

rishikush31 avatar utsav82 avatar

Watchers

 avatar

Forkers

rishikush31

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.