readme styling

LICENSE

@@ -0,0 +1,9 @@
+ The MIT License (MIT)
+
+Copyright © 2021 <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,15 +1,112 @@
-<h1 align="center">
-   <img src="https://user-images.githubusercontent.com/71537090/167278902-b564cc78-d48d-44e6-b4ff-120e00406ddb.png" alt="Logo Next Level Week Return" />
-</h1>
+<p align="center">
+   <img src="https://user-images.githubusercontent.com/71537090/167278902-b564cc78-d48d-44e6-b4ff-120e00406ddb.png" alt="Logo Next Level Week Return" width="250px"/>
+</p>
 
-<p align="center" margin-top="25px" >
-  <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/Azanniel/nlw-return?color=blueviolet">
+<p align="center">
+  <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/yuriqpaiva/feedget?color=blueviolet">
 
-  <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/Azanniel/nlw-return?color=blueviolet">
+  <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/yuriqpaiva/feedget?color=blueviolet">
 
-  <img alt="GitHub" src="https://img.shields.io/github/license/Azanniel/nlw-return?color=blueviolet">
+  <img alt="GitHub" src="https://img.shields.io/github/license/yuriqpaiva/feedget?color=blueviolet">
 </p>
 
 ![image](https://user-images.githubusercontent.com/71537090/167278997-56d6c6a9-e477-4910-b512-23feb2fff54f.png)
 
-# Technologies
+<br>
+
+# 💡 Introduction
+
+Full-stack application Feedback Widget
+
+1. Allows users to leave feedback about Problems, Ideas and Others
+2. Send a comment
+3. Send a screenshot of application's screen if necessary
+4. Feedback submission goes to application's support via email
+
+<br>
+
+# 🧪 Technologies
+
+Technologies that were used on this application:
+
+- [React](https://reactjs.org)
+- [Tailwindcss](https://tailwindcss.com)
+- [Vite](https://vitejs.dev)
+- [TypeScript](https://www.typescriptlang.org)
+- [Express](https://expressjs.com/pt-br)
+- [Prisma](https://www.prisma.io)
+- [Jest](https://jestjs.io)
+- [React Native](https://reactnative.dev/)
+- [Expo](https://expo.dev/)
+
+<br>
+
+# 🖥 Pre-requisites:
+
+- NodeJS
+- Expo
+- Yarn
+- Database compatible with [Prisma](https://www.prisma.io)
+
+<br/>
+
+# 🚀 How to Run it?
+
+From project's root file:
+
+## Web application:
+
+```sh
+$ cd web
+$ yarn install
+$ yarn dev
+```
+
+## Mobile:
+
+```sh
+$ cd mobile
+$ yarn install
+$ yarn start
+```
+
+## Backend
+
+```sh
+$ cd server
+$ yarn install
+# Run migrations
+$ npx prisma migrate dev 
+$ yarn dev
+
+# Run prisma studio on another console
+$ npx prisma studio
+```
+
+<br/>
+
+# ⚙️ Environment Variables
+
+Here are some examples of how you can set up your `.env` files
+
+## On Web application:
+
+```js
+VITE_API_URL='http://localhost:3333';
+```
+
+## On Backend:
+```js
+DATABASE_URL="postgresql://root:root@192.168.0.5:5432/feedbacks"
+```
+
+<br>
+
+## 📝 License
+
+MIT License © Yuri Paiva. Check this [LICENSE](LICENSE.md) for more details
+
+---
+<br>
+
+Made with 💜 &nbsp;by Yuri Paiva