README.md

Next Wallet - Track your expenses

Table of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Features
• Contributing
• License
• Contact
• Acknowledgements

About the Project

The "Next Wallet" project is a web-based wallet application built with Next.js. Its primary purpose is to provide users with a convinient and user-friendly interface for managing their money. The main features include user authentication, data management, and a dashboard for viewing accounts statistics. The project aims to simplify the management of money by integrating the most important features into a single, accessible platform.

Built With

• React - Frontend library
• Node.js - Backend runtime
• Next.js - The React Framework for the Web
• NextAuth - Authentication for Next.js
• PostgreSQL - Database
• Prisma - ORM
• Tailwind CSS - CSS framework
• shadcn/ui - UI Component Library

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone [email protected]:abucan/next-wallet.git

2. Install NPM packages

   npm install

3. Set up environment variables Create a .env file in the root directory and add the following:

   DATABASE_URL=your_database_url
   POSTGRES_URL=your_postgres_url
   POSTGRES_DATABASE=your_postgres_database
   POSTGRES_HOST=your_postgres_host
   POSTGRES_PASSWORD=your_postgres_password
   POSTGRES_USER=your_postgres_user
   POSTGRES_PRISMA_USER=your_postgres_prisma_user
   POSTGRES_PRISMA_URL=your_postgres_prisma_url
   POSTGRES_URL_NON_POOLING=your_postgres_url_non_poolin
   AUTH_SECRET=your_next_auth_secrent
   GITHUB_CLIENT_SECRET=your_github_client_secret
   GITHUB_CLIENT_ID=your_github_client_id

Usage

1. Run the Development Server:

npm run dev

2. Build for Production:

npm build
npm start

Features

• User Authentication
• Github Auth
• Dashboard
• Light/Dark Mode
• Transaction Managment
• Personal Accounts/Records
• Responsive and Minimalist Design

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ante Bucan - LinkedIn - [email protected]
Github Link: https://github.com/abucan/next-wallet/
Project Live Link: https://next-wallet-tracker.com/

Acknowledgements

• React Documentation
• Next.js Documentation
• NextAuth Documentation
• Node.js Documentation