Giter VIP home page Giter VIP logo

xspends's Introduction

XSpends: Simple Transaction system API Service

Go Go Coverage

Overview

XSpends is a attempt to make a primitive/basic yet (arguably) complete API driven system to manage a transaction system. It offers functionalities like user authentication, transaction recording, fund source tracking, and spend categorization.

Features

  • User Authentication: Secure user registration and login.
  • Transaction Management: Record and manage financial transactions.
  • Fund Source Management: Keep track of different financial sources.
  • Expense Categorization: Organize expenses with categories and tags.

Getting Started

Prerequisites

  • Docker
  • Helm (for Kubernetes deployments)
  • Minikube (for local Kubernetes setup)

Installation

For detailed installation instructions, refer to install.md. This includes steps for Minikube setup, TiDB setup using Helm, and deploying XSpends.

Accessing the Service

Use minikube service xspends-service --url to get the service URL for accessing the API.

Usage

Make RESTful API requests to the provided service URL. Example endpoints:

  • /auth/register (POST): Register a new user.
  • /auth/login (POST): Login for existing users.
  • /transactions (POST/GET): Manage transactions.

Refer to the API documentation (if available) for detailed usage.

Development

  • Local Development: Use docker-compose up.
  • Testing: Execute tests/basic_sanity.sh for basic checks.
  • Rebuild and Redeploy: Instructions available in install.md.

Contributing

Contributions to XSpends are welcome! Please read our contributing guidelines for details on how to contribute.

License

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

xspends's People

Contributors

codevalley avatar

Watchers

 avatar  avatar

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.