Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yuriqpaiva committed Jun 6, 2022
1 parent 28d5d84 commit 25690be
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -25,7 +25,7 @@ Full-stack application Feedback Widget

<br>

# πŸ§ͺ Technologies
## πŸ§ͺ Technologies

Technologies that were used on this application:

Expand All @@ -41,7 +41,7 @@ Technologies that were used on this application:

<br>

# πŸ–₯ Pre-requisites:
## πŸ–₯ Pre-requisites:

- NodeJS
- Expo
Expand All @@ -50,7 +50,7 @@ Technologies that were used on this application:

<br/>

# πŸš€ How to Run it?
## πŸš€ How to Run it?

From project's root file:

Expand All @@ -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
Expand All @@ -85,28 +86,37 @@ $ npx prisma studio

<br/>

# βš™οΈ 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://<username>:<password>@<hostname>:<port>/<database>"
DATABASE_URL =
'postgresql://<username>:<password>@<hostname>:<port>/<database>';
```

<br>

## πŸ”– Layout

Check Figma Layout of this project [here](https://www.figma.com/community/file/1102912516166573468/Feedback-Widget)

<br>

## πŸ“ License

MIT License Β© Yuri Paiva. Check [LICENSE](LICENSE.md) for more details

---

<br>

Made with πŸ’œ &nbsp;by Yuri Paiva
Made with πŸ’œ &nbsp;by Yuri Paiva

1 comment on commit 25690be

@vercel
Copy link

@vercel vercel bot commented on 25690be Jun 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

feedget – ./

feedget-git-main-yuriqpaiva.vercel.app
feedget-yuriqpaiva.vercel.app
feedget-swart-six.vercel.app

Please sign in to comment.