README.md

Li-Invest

Access the application here

Li-Invest is an application for managing investments, providing features such as simulations, investment history, and profitability analysis. This application utilizes various technologies, including CDB, RDB, LCI, LCA, and savings.

Table of Contents

• Installation
• Usage
• Project Structure
• Contribution
• License

Installation

Prerequisites

• Node.js (v20.15.0)
• npm (v10.7.0)

Steps to Install

1. Clone the repository:

   git clone https://github.com/WillianAgostini/li-invest.git

2. Navigate to the project directory:

   cd li-invest

3. Install the dependencies:

   npm install

4. Configure the environment variables as needed (example of .env provided in the repository).

Usage

Available Commands

• Start the development server:

  npm run dev

• Run tests:

  npm test

• Generate production build:

  npm run build

Contribution

If you wish to contribute to this project, follow the steps below:

1. Fork the repository.

2. Create a branch for your feature or bugfix:

   git checkout -b my-feature

3. Commit your changes:

   git commit -m 'Add new feature'

4. Push to the main branch:

   git push origin my-feature

5. Open a Pull Request.

License

This project is licensed under the GNU License. See the LICENSE file for more details.