Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bfukumori/feedget

App "feedget" developed during NLW Return from Rocketseat
https://github.com/bfukumori/feedget

axios expo expressjs headlessui html2canvas mailtrap nodejs nodemailer phosphoricons prisma rocketseat-nlw tailwindcss vite

Last synced: about 1 month ago
JSON representation

App "feedget" developed during NLW Return from Rocketseat

Host: GitHub
URL: https://github.com/bfukumori/feedget
Owner: bfukumori
License: mit
Created: 2022-05-08T22:12:09.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-10-31T03:01:25.000Z (about 2 years ago)
Last Synced: 2023-03-04T20:48:46.145Z (almost 2 years ago)
Topics: axios, expo, expressjs, headlessui, html2canvas, mailtrap, nodejs, nodemailer, phosphoricons, prisma, rocketseat-nlw, tailwindcss, vite
Language: TypeScript
Homepage:
Size: 695 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

  

 

  

    

  

    

   

   

    

  

  

    

  





    





  About •

  Features •

  How it works • 

  Tech Stack • 

  Author • 

  License



 

	



## About

💡 feedget - App to send feedbacks.

Project developed during the NLW Return Week from [Rocketseat](https://www.rocketseat.com.br/ignite).

---

## Features

- [x] Create a feedback

- [x] Dashboard with all created feedbacks

- [x] Light/Dark Theme

---

## How it works

### Pre-requisites

Before you begin, you will need to have the following tools installed on your machine:

[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/).

In addition, it is good to have an editor to work with the code like [VSCode](https://code.visualstudio.com/) and Expo app (if using mobile version) [Android](https://play.google.com/store/apps/details?id=host.exp.exponent) or [iOS](https://apps.apple.com/app/expo-go/id982107779). 

Create an account and configure this external service if you want to use a fake mail:

- [Mailtrap](https://mailtrap.io/)

#### Running the server (Backend)

```bash

# Clone this repository

$ git clone [email protected]:bfukumori/feedget-nwl-return-impulse.git

# Access the project folder in your terminal

$ cd feedget-nwl-return-impulse/server

# Install the dependencies

$ npm install

# In project root rename .env.local.example to .env.local

# Change the variable values according to the instructions in .env.local.example

# Run the application in development mode

$ npm run dev

```

---

#### Running the web application (Frontend)

```bash

# Clone this repository

$ git clone [email protected]:bfukumori/feedget-nwl-return-impulse.git

# Access the project folder in your terminal

$ cd feedget-nwl-return-impulse/web

# Install the dependencies

$ npm install

# In project root rename .env.local.example to .env.local

# Change the variable values according to the instructions in .env.local.example

# Run the application in development mode

$ npm run dev

# The app will open on the port: 3000 - go to http://localhost:3000/

```

---

#### Running the mobile app

```bash

# Clone this repository

$ git clone [email protected]:bfukumori/feedget-nwl-return-impulse.git

# Access the project folder in your terminal

$ cd feedget-nwl-return-impulse/mobile

# Install the dependencies

$ npm install

# Install the expo cli

$ npm install --global expo-cli

# Run the application in development mode

$ expo start

```

---

## Tech Stack

The following tools were used in the construction of the project:

#### **Website**  ([React](https://reactjs.org/)  +  [TypeScript](https://www.typescriptlang.org/))

- **[Headlessui](https://headlessui.dev/)**

- **[Axios](https://axios-http.com/)**

- **[html2canvas](https://html2canvas.hertzen.com/)**

- **[Mailtrap](https://mailtrap.io/)**

- **[PhosphorIcons](https://phosphoricons.com/)**

- **[Vite](https://vitejs.dev/)**

- **[Tailwindcss](https://tailwindcss.com/)**

#### **Server**  ([Nodejs](https://nodejs.org/en/)  +  [TypeScript](https://www.typescriptlang.org/))

- **[Prisma](https://www.prisma.io/)**

- **[Nodemailer](https://nodemailer.com/about/)**

- **[Expressjs](https://expressjs.com/pt-br/)**

#### **Mobile**  ([React Native](https://reactnative.dev/)  +  [TypeScript](https://www.typescriptlang.org/))

- **[Expo](https://expo.dev/)**

- **[phosphor-react](https://phosphoricons.com/)**

- **[Axios](https://axios-http.com/)**

---

## Author



 

 


  

 _{Bruno Fukumori} 

 


[![Twitter Badge](https://img.shields.io/badge/-Twitter-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/hi_fukujp)](https://twitter.com/hi_fukujp) [![Linkedin Badge](https://img.shields.io/badge/-Linkedin-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/bfukumori/)](https://www.linkedin.com/in/bfukumori/) 

[![Gmail Badge](https://img.shields.io/badge/-Gmail-c14438?style=flat-square&logo=Gmail&logoColor=white&link=mailto:[email protected])](mailto:[email protected])

---

## License

This project is under the license [MIT](./LICENSE).

---