What is this?

This is a fork from cypress-io/cypress-realworld-app. Go read their README for more info about Cypress' Real World App.

Motivations

I've been consuming a lot of media how to code differently. This is a project for me to refactor and implement the different best practices. What I hope to achieve:

• Domain-Driven Design
  • Functional Domain Modeling
• Clean Architecture
• Living Documentation
  • Cypress
  • Storybook
  • jsdoc-to-markdown + GitBook

Getting Started

Prerequisites

The only requirement for this project is to have Node.js version 12 installed on your machine. Refer to the .node-version file for the exact version.

TypeScript will be added as a local dependency to the project, so no need to install it.

Installation

yarn install

Run the app

yarn dev

Start Cypress

yarn test

Additional Yarn Scripts

Script	Description
list:dev:users	Provides id and username for users in the dev database. The default password for all users is s3cret.
dev	Starts backend in watch mode and frontend
start	Starts backend and frontend
test	Open Cypress
test:mobile	Open Cypress with mobile viewport
test:coverage	Generate Coverage report. view the report at coverage/index.html.
prettier	Make code prettier