Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hayatoinkz/chargeline

A gas station management
https://github.com/hayatoinkz/chargeline

bun docker jest nestjs nextjs postgresql react shadcn-ui tailwindcss

Last synced: about 2 months ago
JSON representation

A gas station management

Host: GitHub
URL: https://github.com/hayatoinkz/chargeline
Owner: hayatoinkz
Created: 2023-11-10T03:06:11.000Z (about 1 year ago)
Default Branch: develop
Last Pushed: 2023-11-15T20:33:43.000Z (about 1 year ago)
Last Synced: 2024-03-08T00:36:55.962Z (10 months ago)
Topics: bun, docker, jest, nestjs, nextjs, postgresql, react, shadcn-ui, tailwindcss
Language: TypeScript
Homepage:
Size: 2.81 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        ![Logo](./.github/assets/logo_dark.svg#gh-dark-mode-only)

![Logo](./.github/assets/logo_light.svg#gh-light-mode-only)

# ChargeLine

Nosso projeto para gestão de combustíveis.

## Stack utilizada

**Front-end:** React, NextJS, TailwindCSS, RadixUI, Shadcn/UI, Zod, React Hook Form, SWR

**Back-end:** Node, NestJS, Jest, Docker

**Banco de Dados:** TypeORM, PostgreSQL

## Processo

Comecei modelando o banco de dados seguindo os requisitos funcionais como base e adicionando algumas tabelas que achei necessárias.

![DB](./docs/db.png)

[Acesse o diagrama](./docs/db.dmbl)

Em seguida, criei um Design no Figma para poder visualizar melhor o funcionamento do sistema, utilizei algumas bibliotecas e tokens como TailwindCSS e Shadcn/UI.

![Figma](./docs/screenshots/figma.png)

[Acesse o Figma](https://www.figma.com/file/aRxRfK4EWf6muUNq5Vu60c/%F0%9F%96%A5%EF%B8%8F-App-%E2%80%A2-Fluxstation?type=design&node-id=505%3A9368&mode=design&t=enqLdTvo1YpKXlKl-1)

## Documentação

[Backend](./backend/README.md)

[Frontend](./frontend/README.md)

## Instalação

Instale o ChargeLine com `bun`

```bash

curl -fsSL https://bun.sh/install | bash

git clone [email protected]:hayatojpg/chargeline.git

```

# Rodando localmente

## Rodar Back-end

```bash

cd chargeline/backend

cp env-example .env

docker compose up -d

```

Rodando localmente em [http://localhost:3001/api/v1](http://localhost:3001/api/v1)

Swagger em [http://localhost:3001/docs](http://localhost:3001/docs)

## Rodar Front-end

```bash

cd.. && cd frontend

cp .env.example .env

bun install

bun dev

```

Rodando localmente em [http://localhost:3000](http://localhost:3000)

## Telas

![Login](./docs/screenshots/login.png)

![Register](./docs/screenshots/register.png)

![Empty](./docs/screenshots/empty.png)

![History](./docs/screenshots/history.png)

![AddCar](./docs/screenshots/add-car.png)

![DeleteCar](./docs/screenshots/delete-car.png)

## Referência

- [Next.js](https://nextjs.org/docs)

- [TailwindCSS](https://tailwindcss.com/)

- [RadixUI](https://www.radix-ui.com/)

- [Shadcn/UI](https://ui.shadcn.com/)

- [NestJS](https://nestjs.com/)

- [TypeORM](https://www.npmjs.com/package/typeorm)