typeetfunc / pokedex-test

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PokeDex Test App

Stack

Project builded by:

  • lerna
  • react
  • next.js
  • typescript
  • storybook
  • node

Project uses different tsconfig for dev and build envs, for better typescript code navigation. Inspired by article about lerna and typescript caveats.

Packages

  • pokedex: main next.js app
  • components: reusable components for pokedex app
  • utils: reusable pure functions and types for pokedex app and components

Available Scripts

Note: Project uses yarn. Please, install it before using.

Also, Preferably use nvm. You can setup right version of node run at root of project nvm use. Preferably use node version > 18.

Before start you need install dependencies by yarn install

In the project directory, you can run:

yarn run pokedex:dev

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

yarn run build

Builds the app for production to the dist folders.

yarn run components:storybook

Start storybook dev server for components package. Open http://localhost:6006 to view it in the browser.

Run only after building all dependenciew by build command.

yarn run lint

Run eslint over packages

yarn run prettier

Re-format source code at packages

yarn run docker:build

Build docker image for pokedex app

yarn run docker:run

Run builded docker image. Run only after building image by docker:build command

About


Languages

Language:TypeScript 85.5%Language:JavaScript 10.7%Language:Dockerfile 3.8%