Expenseably

Manage your expenses and incomes without tears or fears
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Dev mode
   • Dev mode with mock server
   • Build
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

Built With

• Next.js

Getting Started

Prerequisites

• You need to have Node.js installed before installing the dependencies.
• Setup Estateably API (if you prefer, you can launch with the mock server).

Installation

Follow these steps

1. Install packages

   yarn install or npm install

2. create a .env file with this content:

   NEXT_PUBLIC_API_BASE_URL = "http://localhost:5000";

Usage

⚠️ Since the application doesn't support creating new users, use the following credentials to get logged in:

email: walter_white@gmail.com
password: HelloWorld@123

This credential is also valid for the Demo.

Dev mode

1. Run

   yarn dev or npm run dev

2. Open on the browser: http://localhost:3000

Dev mode with Mock server

1. Run

   yarn dev:mock or npm run dev:mock

2. Open on the browser: http://localhost:3000

Build

To build the project, just run:

yarn build or npm run build

This script will not only build the project but also export it as a static website.

Roadmap

• Add Cypress to E2E test
• Adapt GUI to be responsible for mobile devices
• Improve error display

License

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

Contact

Gabriel Mochi - Linkedin - gmochi56@icloud.com

Acknowledgments

• Chakra UI
• Mirage JS