Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rwalle61/mood-app-kata
This is a simple ReactJS front-end that allows a user to check-in with how they are feeling, and view their history.
https://github.com/rwalle61/mood-app-kata
Last synced: 14 days ago
JSON representation
This is a simple ReactJS front-end that allows a user to check-in with how they are feeling, and view their history.
- Host: GitHub
- URL: https://github.com/rwalle61/mood-app-kata
- Owner: rwalle61
- Created: 2020-07-14T13:40:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T03:19:21.000Z (almost 2 years ago)
- Last Synced: 2024-10-06T02:21:36.515Z (3 months ago)
- Language: TypeScript
- Homepage: https://moodmonitor.netlify.app/
- Size: 1.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mood Monitor Kata
Try it out at https://moodmonitor.netlify.app
## Table of Contents
- [Overview](#overview)
- [Getting Started](#getting-started)
- [Running the Tests](#running-the-tests)
- [Acknowledgments](#acknowledgments)
## Overview
This is a simple ReactJS front-end that allows a user to check-in with how they are feeling, and view their history.
I originally included a server and Cypress because I intended to store the health data in the backend. I may implement that if I have time.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
[Download Node.js v8 or above](https://github.com/nodejs/node#download)
### Installing
Clone the repo
```bash
git clone [email protected]:rwalle61/nodeReactStarterApp.git
```
Install dependencies
```bash
yarn install
```
### Run the app
```bash
yarn build
yarn start
```
The app will be running at `http://localhost:9100`.
Alternatively, you can run `yarn start` from
- `/server` to start only the server
- `/client` to start only the client
### Run the app in development mode
Run `yarn start:dev` from the root directory to start both the client and server in 'hot-restart' mode. Editing the client code will restart the client; editing the server code will restart the server
The client app will be running at `http://localhost:3000`.
The server will be running at `http://localhost:9100`.
## Running the Tests
### All tests
```bash
yarn test:full
```
Run this from the root directory to run integration and component tests for both the client and server.
### End-to-end tests
We use [Cypress](https://www.cypress.io/) to perform client-server integration tests. Cypress manipulates our client, checking that calling the server's API renders the correct components.
If the app is already running, run these tests via the following command:
```bash
# With Cypress UI
yarn cypress:open
# Without Cypress UI, in command line
yarn cypress:run
```
If the app is not already running, use the following command to start the app, run the integration tests, then clean up:
```bash
yarn test:integration
```
### Component tests
These do not require the app to be running.
#### Client
We use [Jest](https://jestjs.io/) to test that the client's components render correctly.
```bash
cd client
# Run all component tests
jest
# Run all component tests in watch mode
jest --watch
```
#### Server
We use [Jest](https://jestjs.io/) to test our server's APIs.
```bash
cd server
# Run all API tests
yarn test
# Run all API tests and generate coverage report
yarn test:coverage
```