Skip to content

Commit

Permalink
Readme changed with e2e instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JVGS1111 committed Aug 9, 2024
1 parent 8e99f4c commit 746436a
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## About

- [News Aggregator](https://news-aggregator-web-app.vercel.app/) is a project that aggregates news from various places in one place, made with love, nextJs and Tailwindcss.
- [News Aggregator](https://news-aggregator-web-app.vercel.app/) is a project that aggregates news from various places in one place, made with love, NextJS and Tailwindcss.
The project has Lint and also uses Prettier to format Tailwindcss classes. Install the extensions to get the most out of it.

## Getting Started
Expand All @@ -13,7 +13,7 @@ First, you will need to get 3 api keys, they are from:
- [News Api](https://newsapi.org/)
- [The Guardian API](https://open-platform.theguardian.com/)

Get these key and create a .env at the root of the project,
Get these keys and create a .env at the root of the project,
there is a .env.example at the root.

to run the project you will need to have [Docker](https://www.docker.com/) installed .
Expand All @@ -31,13 +31,18 @@ if you want to run the project for the second time run:
docker compose up
```

## Tests
## Tests - unit/e2e

There are some unit test, if you want to run them, execute:
There are some unit tests, if you want to run them, execute:
```bash
npm run test
```

The e2e tests were done with Playwright. They were already installed with Docker. Access with:
```bash
http://localhost:3333/
```

## Overview

The most recent posts from each provider are displayed on the home page, they were loaded server-side and are cached for 30 minutes
Expand Down

0 comments on commit 746436a

Please sign in to comment.