Quotes

A Next.js application serving a list of quotes using the Notion API.

Contents

• Getting started
  • Prerequisites
  • Installation
• Usage
  • Running the application
  • Running the tests
  • Formatting the code
  • Linting the code

Getting started

Prerequisites

• Docker (optional)
• NodeJS
  • run nvm install if using NVM
• NPM

Installation

1. Clone the repo

git clone git@github.com:yusufsheiqh/quotes.git

2. Install packages in quotes directory

npm i

Usage

Running the application

To run the application for local development:

npm run dev
npm run dev:docker # using Docker

Then visit http://localhost:3000.

Running the tests

To run all the tests:

npm run test

To run unit tests:

npm run test:unit

To run acceptance tests:

npm run test:acceptance

To run journey tests:

npm run test:journey # to automatically run the tests in headless mode
npm run test:journey:open # to interactively run the tests in a browser

Formatting the code

To run the formatter (using Prettier):

npm run format

Linting the code

To run the linter (using ESLint):

npm run lint