Miconomy

Personal finance tracker web app. Built with NextJS & GraphQL

Features

• Apollo client: A GraphQL client library
• NextJS: React framework with SSR
• Chakra UI: CSS framework to work with styles
• Styled components: CSS in JS library to manage styles (To be depracated)
• Typescript: Programming language with static typings
• Jest: Test runner
• Git hooks with Husky and Linted staged: To help checking test and formatters before a commit
• Vercel: Deployment platform
• ESLint: Validate the Typescript code style with best practices
• Prettier: Formatter files with configured options

Prerequisites

• Yarn
• Latest NodeJS version

Installation

• Clone this repo
• Run on terminal yarn to install dependencies
• Create a .env file and ask a teammate to share the content
• Run on terminal yarn dev and start rocking

Available commands

Run development server

yarn dev

Generate production server

yarn build

Run a production server

yarn start

Run tests

yarn test

Run unit tests

yarn test:unit

Run watching tests

yarn test:watch

Run coverage tests

yarn test:coverage

Run cypress

• run it on its own window

yarn e2e:watch

• these end to end tests can also be open on the terminal directly

yarn e2e:run

Run linter on js and ts files

yarn lint

Run formatter

yarn fmt

Run formatter and linter

yarn pretty