Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henrique-leme/vault-track
https://github.com/henrique-leme/vault-track
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/henrique-leme/vault-track
- Owner: henrique-leme
- Created: 2024-05-22T02:32:25.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-22T18:05:03.000Z (7 months ago)
- Last Synced: 2024-05-22T19:27:18.459Z (7 months ago)
- Language: TypeScript
- Size: 320 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-woovi-challenge - VaultTrack - VaultTrack - Woovi Challenge CRUD Bank [@henrique-leme](https://github.com/henrique-leme) (Challenges Fullstack)
README
# 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](#getting-started)
- [How to Run](#how-to-run)
- [Development](#development)
- [Authors](#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:
```sh
git clone https://github.com/henrique-leme/vault-track.git
```
2. Navigate to the client project directory:
```sh
cd vault-track/
```
3. Copy the environment configuration file in:
the server and client folder inside app
```sh
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:
```sh
pnpm install
```
## ⚙️ How to Run
1. Start the development server:
```sh
pnpm dev
```
### 📦 Deployment
- Steps to the deployment will be included in the futere
### 🛠️ Built With
- Client:
- [React](https://reactjs.org/) - The library for building user interfaces
- [TypeScript](https://www.typescriptlang.org/) - The programming language
- [Vite](https://vitejs.dev/) - The build tool
- [Relay](https://relay.dev/) - The GraphQL framework
- [TailwindCSS](https://tailwindcss.com/) - The CSS framework
- [Storybook](https://storybook.js.org/) - The tool for UI component
development
- [Vitest](https://vitest.dev/) - The tests
- Server:
- [Node.js](https://nodejs.org/) - The runtime environment
- [Koa](https://koajs.com/) - The web framework
- [TypeScript](https://www.typescriptlang.org/) - The programming language
- [GraphQL](https://graphql.org/) - The query language
- [MongoDB](https://www.mongodb.com/) - The database
- [Jest](https://jestjs.io/) - The tests
## ✒️ Authors
- **Henrique** - _Developer_ - [GitHub](https://github.com/henrique-leme)
See also the list of [contributors](https://github.com/henrique-leme/vault-track/contributors) who participated in this project.