Skip to content

Commit

Permalink
style: readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoEscaleira committed Apr 27, 2024
1 parent 896b489 commit c1a57b5
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# Meet the countries - Backend

## Get started
## Getting Started on the app

...
First, open docker and run compose:

```bash
docker compose up -d
```

Second, make sure to have the dependencies installed and run the dev server:

```bash
yarn install
yarn dev
```

Open [http://localhost:8000/graphql](http://localhost:3000) with your browser to see the result.

In order to run lint, do:
```bash
yarn lint
```

## Requirements
1. Node 18+
2. Yarn
3. Docker

0 comments on commit c1a57b5

Please sign in to comment.