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

https://github.com/andersondev96/nlw_return

Projeto desenvolvido no NLW Return da Rocketseat
https://github.com/andersondev96/nlw_return

Last synced: 3 months ago
JSON representation

Projeto desenvolvido no NLW Return da Rocketseat

Awesome Lists containing this project

README

          

# NLW Return
Projeto desenvolvido na Trilha Impulse do NLW Return

![GitHub language count](https://img.shields.io/github/languages/count/andersondev96/nlw_return?color=blue)
![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/andersondev96/nlw_return?color=blue)
![GitHub repo size](https://img.shields.io/github/repo-size/andersondev96/nlw_return?color=blue)
![GitHub](https://img.shields.io/github/license/andersondev96/nlw_return?color=blue)

[Sobre o Projeto](#-sobre-o-projeto) | [Tecnologias](#-tecnologias) | [Layout](#-layout) | [Como executar a aplicação](#-como-executar-a-aplicação) |
[Como contribuir](#-como-contribuir) | [Licença](#-licença) | [Autor](#-autor)

![Capa-Nlw Return](https://github.com/andersondev96/nlw_return/assets/49786548/af119b18-bfeb-4076-a01f-3545348b1065)

## 📄 Sobre o projeto
Esse projeto é um widget que pode ser usado em aplicações web e mobile para receber feedback de usuários.

## 🧑‍💻 Tecnologias
[![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/)
[![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)](https://react.dev/)
[![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)](https://expressjs.com/pt-br/)
[![Prisma](https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white)](https://www.prisma.io/)
[![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)](https://jestjs.io/pt-BR/)
[![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)](https://vitejs.dev/)
[![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/)

## 🎨 Layout
Você pode acessar o layout da aplicação pelo seguinte link:
- [Layout](https://www.figma.com/file/uvnITluJdqthFw3A2Lu1bt/Feedback-Widget-(Community)?type=design&node-id=142%3A1270&mode=design&t=zVUeQsB0mdYsI6ZE-1)

Lembrando que é necessário possuir uma conta no [Figma](https://www.figma.com/)

## 🚀 Como executar a aplicação
- Clone este repositório:
```
git clone https://github.com/andersondev96/nlw_return
```
- Acesse o backend da aplicação:
```
cd server
```
- Instale as dependências:
```
npm install
```
- Rode as migrations:
```
npx prisma run dev
```
- Execute a aplicação:
```
npm run dev
```
- A aplicação será executada na porta `3333`.
- Para executar os testes da api, execute o comando:
```
npm run test
```
- Com o backend em execução, acesse o frontend da aplicação:
```
cd web
```
- Instale as dependências:
```
npm install
```
- Execute a aplicação:
```
npm run dev
```
- A aplicação estará executando na porta `3000`. Acesse o seu navegador com o endereço `http://localhost:3000`.

## 🤝 Como contribuir?

- Faça um fork desse repositório.
- Crie uma branch com a sua feature: `git checkout -b my-feature`.
- Faça commit das suas alterações: `git commit -m 'feat: My new feature'`.
- Faça push para a sua branch: `git push origin my-feature`.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

## 📝 Licença

Este projeto está sob a licença [MIT](LICENSE).

## 👥 Autor

**Anderson Fernandes Ferreira**

[![instagram](https://img.shields.io/badge/-Instagram-%23E4405F?style=for-the-badge&logo=instagram&logoColor=white)](https://instagram.com/anderson_ff13)
[![email](https://img.shields.io/badge/-Gmail-%23333?style=for-the-badge&logo=gmail&logoColor=white)](mailto:andersonfferreira96@gmail.com.br)
[![linkedin](https://img.shields.io/badge/-LinkedIn-%230077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/anderson-fernandes96/)

Feito com 💚 por Anderson Fernandes 👋 [Entre em contato!](https://www.linkedin.com/in/anderson-fernandes96/)