Skip to content

vimark1/typist

 
 

Repository files navigation

Typist

Build Status Join the chat at https://gitter.im/vimark1-typist/Lobby

Touch typing practice web app in which you type short words and aim to achieve better scores.

Demo: https://typistapp.netlify.app/

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

You need at least node v8.

Installing

Getting the app up and running is pretty simple.

The app uses Firebase for authentication, bundled in the source is a development Firebase version, so you don't need to setup firebase separately.

To get the app up and running, just run npm install and npm start

$ npm install
$ npm start

The console should provide a link to the running app

Running the tests

All the automated tests for the app runs with jest, to run all tests use:

$ npm test

Contributing

Contributions welcome; Please submit all pull requests the against master branch. Or create an issue with a new feature!