apichaikub / the-peaks-react

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Peaks

Introduction

An "Front-End Development Test" for Seven Peaks Software

See live on: https://the-peaks-project.herokuapp.com/

Implementation notes and requirements
  • Next, React latest version
  • TypeScript
  • Styled Components
  • Component Driven User Interfaces
  • Storybook
  • Unit Tests, UI Tests
  • ESLint Coding Styles
  • The Guardian Open platform (REST APIs)
  • PWA for offline access
  • Responsive on desktop and mobile
  • Work on the latest version of Google Chrome
  • Deploy to Heroku

Getting Started

Required:

  • nodejs latest version
# install dependencies from package.json
npm i

Run the project on local:

# for PWA and supported offline mode
npm run dev-pwa

# or basically for development
npm run dev

Open http://localhost:3000 with your browser to see the result.


Testing

Run tests on local (optional):

# run all tests
npm run test

# run ui tests
npm run test:ui

# run unit tests
npm run test:unit

Design System

Run the storybook on local (optional):

npm run storybook

Developed by

Apichai (Chai) Densamut 095-590-8514 apichai.densamut@gmail.com

About


Languages

Language:TypeScript 66.6%Language:JavaScript 29.1%Language:CSS 2.4%Language:Dockerfile 1.9%