Skip to content

joao-ressel/trt

Repository files navigation

Treasure Track

Next.js React TypeScript Supabase Tailwind CSS shadcn/ui Recharts

Exemplo imagem

Treasure Track is a personal finance manager designed to help users gain full control over their money by manually tracking incomes and expenses.

🎯 Project Purpose

  • Serve as a personal project to practice modern web development
  • Promote financial awareness through manual tracking
  • Centralize all financial information in one place
  • Provide clear insights into incomes and expenses

📌 Project Status

🚧 In active development This is a personal project, continuously evolving with new features, UI improvements, and refinements.

✨ Key Features

  • 🧾 Manual income and expense tracking
  • 📊 Interactive dashboard with visual insights
  • 🗂️ Custom categories and accounts
  • 📤 Export transactions table
  • ⚙️ Settings page(Currency and locale preferences)

🤓 Getting Started

☝ Required

  • Node.js >= 20 Recommended: latest LTS version
  • npm (comes with Node.js) or pnpm / yarn
  • Git

💻 Backend & Services

  • Supabase account
  • Used as the database and authentication provider You will need:
    • Supabase Project URL
    • Supabase Anon Public Key

💿 Recommended

  • These tools are not mandatory but improve the development experience:
  • TypeScript (already configured)
  • ESLint (already configured)
  • Modern browser (Chrome, Edge, Firefox)

🚀 Installation & Running Locally

Follow the steps below to run Treasure Track on your local machine.

  1. Clone the repository
   git clone https://github.com/joao-ressel/trt
   cd trt
  1. Install dependencies

Using npm, yarn or :

npm install

Or with :

yarn install

Or with pnpm:

pnpm install
  1. Configure environment variables

Create a .env.local file at the root of the project and add your Supabase credentials:

NEXT_PUBLIC_SUPABASE_URL=https://xxxxx.supabase.co
NEXT_PUBLIC_SUPABASE_PUBLISHABLE_OR_ANON_KEY=sb_publishable_xxxxx
SUPABASE_SECRET_KEY=xxxxxxxxxxxxxxxxxxx

These values can be found in your Supabase project settings.

  1. Run the development server
   npm run dev

The application will be available at:

http://localhost:3000
  1. Build for production (optional)
   npm run build
   npm run start

**Notes

  • This project uses Next.js with Webpack
  • Tailwind CSS and Radix UI are preconfigured
  • Supabase handles authentication and database management

🌐 Live Demo

The application is deployed on Vercel and can be accessed here: https://trt-liart.vercel.app/.

📄 License

This project is licensed under the MIT License. LICENCE for more details.

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors