GithubHelp home page GithubHelp logo

oglassdev / partner-vault Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 1.37 MB

An application for businesses and schools to store information about partners.

License: GNU General Public License v3.0

TypeScript 96.30% HTML 0.32% JavaScript 1.65% Rust 0.67% CSS 1.05%
fbla fbla-coding-and-programming rust solidjs supabase tailwindcss tauri tauri-app typescript

partner-vault's Introduction

Partner Vault

Introduction

Partner Vault is a Tauri-based application developed for the FBLA coding and programming 2023-24 competition. Designed for school, it stores data about business partners, sponsors, etc.

Features

  • Supabase Integration: Supabase is utilized as the backend for the application.
  • Tags: Organize partner information with tags.
  • Partners: Partner data contains a name, type, contacts, and a relationship to tags.
  • Searching and Filtering: Easily search for partners using tags, names, and partner types.
  • Report Generation: Generate reports using Supabase edge functions.
  • Cross-Platform Compatibility: Runs on multiple operating systems.

Installation

Using Releases

  1. Visit the releases page.
  2. Download the latest installer for your operating system.
  3. Run the installer.
  4. Open Partner Vault!

Building from Source

Prerequisites

  • Node.js (v14 or later)
  • Rust (latest stable version)
  • A package manager (npm or yarn)

Steps

  1. Clone the repository:
    git clone https://github.com/oglassdev/partner-vault-v2.git
    
  2. Navigate to the project directory:
    cd partnervault
    
  3. Install dependencies:
    npm install
    
  4. Build the application:
    npm run tauri build
    

Usage

  1. Add/Edit Partner Information: Easily manage partner details.
  2. Utilize Tags: Organize information using tags for efficient categorization.
  3. Generate Reports: Create detailed reports from stored data.
  4. Search for Partners: Quickly find partners using the search feature.

Important Note

Partner Vault is specifically designed to work with a predefined Supabase instance and is not compatible with other instances, unless the format is the same.

Contributing

If you'd like to contribute:

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

License

GPL License

partner-vault's People

Contributors

oglassdev avatar

Watchers

 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.