diff --git a/README.md b/README.md index dba7a91..d03f50e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ # ๐Ÿ’ก Introduction -Full-stack application Feedback Widget +Monorepo of Full-stack application Feedback Widget 1. Allows users to leave feedback about Problems, Ideas and Others 2. Send a comment @@ -25,7 +25,7 @@ Full-stack application Feedback Widget
-# ๐Ÿงช Technologies +## ๐Ÿงช Technologies Technologies that were used on this application: @@ -41,7 +41,7 @@ Technologies that were used on this application:
-# ๐Ÿ–ฅ Pre-requisites: +## ๐Ÿ–ฅ Pre-requisites: - NodeJS - Expo @@ -50,7 +50,7 @@ Technologies that were used on this application:
-# ๐Ÿš€ How to Run it? +## ๐Ÿš€ How to Run it? From project's root file: @@ -75,8 +75,9 @@ $ yarn start ```sh $ cd server $ yarn install + # Run migrations -$ npx prisma migrate dev +$ npx prisma migrate dev $ yarn dev # Run prisma studio on another console @@ -85,28 +86,37 @@ $ npx prisma studio
-# โš™๏ธ Environment Variables +## โš™๏ธ 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'; +VITE_API_URL = 'http://localhost:3333'; ``` ### On Backend: + ```js -DATABASE_URL="postgresql://:@:/" +DATABASE_URL = + 'postgresql://:@:/'; ```
+## ๐Ÿ”– Layout + +Check Figma Layout of this project [here](https://www.figma.com/community/file/1102912516166573468/Feedback-Widget) + +
+ ## ๐Ÿ“ License MIT License ยฉ Yuri Paiva. Check [LICENSE](LICENSE.md) for more details --- +
-Made with ๐Ÿ’œ  by Yuri Paiva \ No newline at end of file +Made with ๐Ÿ’œ  by Yuri Paiva