samueldsr99/web-tooling-homeworks

Jokes ¯\_(ツ)_/¯

Web tooling assignment - Jokes platform

This is the repository for the web tooling assignment at Harbour.Space.

This project is a simple jokes platform that fetches jokes from the JokeAPI.

Vercel deploy

Chromatic

Table of contents

• Web tooling assignment
  • Table of contents
  • Introduction
  • Installation
  • Usage
  • Contributing
  • License

Introduction

A jokes website that fetches jokes from the JokeAPI. You can get jokes by category.

Installation

1. Clone the repository

git clone

2. Copy and populate the environment variables

cp .env.example .env

3. Install the dependencies

npm install

Usage

Development

If you want to start the project in development mode, run the following command:

npm run dev

To start the storybook, run the following command:

npm run storybook

Build for production

To build the project for production, run the following command:

npm run build

Output folder is dist.

Then you can start the project with the following command:

npm start

To build the storybook for production, run the following command:

npm run build-storybook

Output folder is storybook-static.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

License

MIT