Vault Track

Project Status: ⚠️ In Development

Description

Vault Track is a comprehensive service built to manage and track financial transactions securely and efficiently. The frontend provides a seamless and interactive user experience, while the backend ensures secure and high-performance data management. It leverages modern web technologies such as React, Vite, Relay, TailwindCSS, Storybook, Node.js, Koa, GraphQL, and MongoDB.

⚙️ Features

• Frontend:

  • User Interface for Financial Transactions
  • Integration with Backend Services via GraphQL and Relay
  • Responsive Design
  • Interactive Components with ShadcnUI
  • Component-driven development with Storybook

• Backend:

  • User Authentication and Authorization
  • Transaction Management
  • Secure Storage with MongoDB
  • GraphQL API

📚 Documentation

For detailed documentation, refer to the Documentation (link will be added).

To access the documentation locally:

1. Clone the project.
2. Follow the setup instructions below.

📝 Table of Contents

• Getting Started
• How to Run
• Development
• Authors

🚀 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

Ensure you have the following installed:

• Git
• Node.js
• pnpm
• Docker

🔧 Installation

1. Clone the repository:

   git clone https://github.com/henrique-leme/vault-track.git

2. Navigate to the client project directory:

   cd vault-track/

3. Copy the environment configuration file in: the server and client folder inside app

   cp .env.example .env
   
   #Note: This command will not work in WindowsOS, for windows you have to
   #manually copy and paste the .env.exemmple and rename it for .env

4. Install dependencies:

   pnpm install

⚙️ How to Run

1. Start the development server:

   pnpm dev

📦 Deployment

• Steps to the deployment will be included in the futere

🛠️ Built With

• Client:

  • React - The library for building user interfaces
  • TypeScript - The programming language
  • Vite - The build tool
  • Relay - The GraphQL framework
  • TailwindCSS - The CSS framework
  • Storybook - The tool for UI component development
  • Vitest - The tests

• Server:

  • Node.js - The runtime environment
  • Koa - The web framework
  • TypeScript - The programming language
  • GraphQL - The query language
  • MongoDB - The database
  • Jest - The tests

✒️ Authors

• Henrique - Developer - GitHub

See also the list of contributors who participated in this project.