Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 3 KB

README.md

File metadata and controls

55 lines (42 loc) · 3 KB

💰 Finance App

Your partner for you finance health 💚

Finance App

📃 Description

If you want an app to manage your bakings, bills, accounts and trasactions, welcome. Here you can:

  • Create an account as you want with Clerk.
  • Manage transactions, accounts and categories.
  • Import transactions from csv file.
  • Take a look on the overview charts.
  • Filter data for a period.

⚙️ Tech Stack

React JS Typescript next tailwind postgres vercel

💻 How to run

  1. Make sure Git and NodeJS is installed.
  2. Clone this repository to your local computer.
  3. Install the project dependencies using npm install or other similar.
  4. Create .env.local file in root directory.
  5. Contents of .env.local (.env.example):
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
CLERK_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
CLERK_SECRET_KEY=pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

DATABASE_URL="postgresql://<username>:<password>@<neon_host>/<dbname>?sslmode=require"

NEXT_PUBLIC_APP_URL=http://localhost:3000
  1. Set up a Neon PostgreSQL Database
    • If you don't have a Neon PostgreSQL database, create one.
    • Obtain the database URL, which typically looks like postgresql://<username>:<password>@<host>:<port>/<database-name>.
  2. Set up a Clerk App Authentication
  • Create or use your account on clerk and create an application.
  • Go to API Keys section and get the required keys.
  1. The others env values you can just a copy.
  2. Run npm run db:migrate for apply the migrations.
  3. Open terminal and run npm run dev or similars.
  4. You cannpm run db:seed for populate your database.

🚀 Follow Me

GitHub followers Linkedin Badge Instagram Badge

📝 License

This project uses MIT License. You can see the file LICENSE for more details.