https://github.com/joaoscoelho/my-finances-frontend

O My Finances é um site para controle de finanças pessoais open source e com objetivo de ser de fácil utilização e bem otimizado.
https://github.com/joaoscoelho/my-finances-frontend

finances nextjs typescript website

Last synced: 1 day ago
JSON representation

O My Finances é um site para controle de finanças pessoais open source e com objetivo de ser de fácil utilização e bem otimizado.

• Host: GitHub
• URL: https://github.com/joaoscoelho/my-finances-frontend
• Owner: JoaoSCoelho
• License: mit
• Created: 2023-03-12T12:06:51.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-30T23:13:53.000Z (over 1 year ago)
• Last Synced: 2024-11-16T05:12:06.533Z (2 months ago)
• Topics: finances, nextjs, typescript, website
• Language: TypeScript
• Homepage: https://my-finances-frontend.vercel.app
• Size: 2.69 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



[PT](#pt-br) - EN

#### PT-BR

O My Finances é um site para controle de finanças pessoais open source e com objetivo de ser de fácil utilização e bem otimizado.

Tabela de conteúdos

=

  * [Descrição](#)

  * [Tabela de conteúdos](#tabela-de-conteúdos)

  * [Instalação](#instalação)

  * [Como usar](#como-usar)

  * [Status](#status)

  * [Licença](#licença)

  * [Tecnologias utilizadas](#tecnologias-utilizadas)

  * [Para devs](#para-devs)

## Instalação

Você precisa do [Git](https://git-scm.com) e do [Node.JS](https://nodejs.org/) instalados na sua máquina (recomendo Node >=18.0.0).

```bash

# Clone este repositório

$ git clone 

# Acesse a pasta do projeto no terminal/cmd

$ cd my-finances-frontend

# Instale as dependências

$ npm install

```

## Como usar

❗❕ Antes de iniciar o site, você precisa iniciar o servidor, para isso clone o repositório <https://github.com/JoaoSCoelho/my-finances-backend> e siga os passos para inicialização.


Primeiramente, crie um arquivo chamado `.env.local` na raíz do projeto. (você pode renomear o arquivo `.env.local.example` para `.env.local`)

```env

NEXT_PUBLIC_BASE_API_URL=AQUI VOCÊ DEVE COLOCAR A URL DA API QUE ESTÁ RODANDO, COMO POR EXEMPLO: http://localhost:3333

```

```bash

# Execute a aplicação em modo de desenvolvimento

$ npm run dev

# ou em modo de produção

$ npm run build

$ npm run start

# O site iniciará na porta:3000 - acesse 

```

o site irá rodar por padrão em `localhost:3000`, para visualizar abra [`http://localhost:3000`](http://localhost:3000) no seu navegador.

![Home](resources/usage-gif.gif)

## Status

> **🚧 Em construção... 🚧 v1.0.1**

### Features

- [x] Cadastro de usuário

- [x] Cadastro, edição e remoção de contas bancárias

- [x] Cadastro, edição e remoção de transações (Receitas, Despesas e Transferências)

## Licença

[MIT](https://choosealicense.com/licenses/mit/)

## Tecnologias utilizadas



  

  

  



React | Next.JS | TypeScript

### Bibliotecas populares utilizadas



  

  

  

  

  

  

  



SWR | Axios | React Hook Form | Yup | React Icons | React Loading Skeleton | Day.JS

## Para devs

Para mais detalhes do código do projeto, estrutura de pastas, componentes produzidos, entre outras coisas: entre no arquivo [code-details.md](code-details.md).