typvp

typvp is a Single/Multiplayer type racing game, akin to 10fastfingers or typeracer.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Make sure you have yarn installed on your system.

yarn -v

Installing

Clone typvp

git clone https://github.com/typvp/typvp.git

Install dependencies

yarn

Hopefully everything goes smoothly.

Running/Building

Running typvp locally:

yarn start

Build typvp locally (doesn't fail, etc):

yarn build

Running the tests

// todo

Deployment

Once a PR/commit is merged to next Netlify will build typvp and deploy it.

Built With

• react - Library
• styled-components - Styling
• mobx - State Managment
• urql - GraphQL Library
• yup + react-hook-form - Forms & Validation
• framer motion - Animation

Contributing

// todo Submit an issue highlighting the problem/changes that you want to make (or see made). After triage (or if you want to work on it immediately) submit a PR that is tied to the respective issue :)

Versioning

We will use semver for versioning, but right now we aren't tracking versions.

Authors

• Evan Kysley - Core - kysley

License

This project is licensed under BSD-3-Clause - see the LICENSE.md file for details

Acknowledgments

• typings.gg for big inspiration
• 10fastfingers
• typeracer