bpinela / popcorn-frontend-challenge

A frontend challenge for Popcorn network

Popcorn Frontend Challenge

Table of Contents

• Setup and Run
• Technologies

Setup and Run

Developer mode

• Install dependencies:

$ yarn

• Create .env based on .env.example
• Configure the envs

NEXT_PUBLIC_GOOGLE_BOOK_API_URL=
NEXT_PUBLIC_API_KEY=
NEXT_PUBLIC_APP_URL=

• Run $ yarn dev

Production mode

• Install dependencies:

• Run $ yarn

• Run $ yarn build

• Run $ yarn start

Tests and Coverage

• Run tests $ yarn test
• Run test coverage $ yarn test-coverage

Technologies

• NextJS as the frontend framework to build the app
• Jest as a test tool
• React-testing-library as a tool to test UI
• Eslint to code pattern
• Husk a git hook that run prettier, eslint and tests when doing commit
• Typescript to code typecheck

ToDo

• Add storybook
• Improve the UI
• I18n to localization
• Improve test coverage

What could be improved

Please check the issues section to see more.