Typing-Royale

Description

A retro themed typing game that allows players to compete head to head over the web.

Table of Contents

• Typing-Royale
  • Description
  • Table of Contents
  • Motivation
  • Demo
  • Screenshots
  • Technologies
    • Front-End
    • Back-End
  • Installation
  • Contributing
  • License

Motivation

Inspired by single-player typing websites, Typing Royale was created to settle, once and for all, who is the fastest typist in the office. Sure, you can take individual typing tests and compare results, but where is the fun in that? A live, head to head, adrenaline-pumping battle with all bragging rights on the line? Now that's is a true typing test. Good luck, and may the fastest typist win 🏆🏆🏆.

Demo

Screenshots

Technologies

Front-End

• Framework
  • React
• State Management
  • React Hooks
• Routing
  • React Router
• User Interface
  • NES CSS

Back-End

Link to Back-End Repo

• API
  • Ruby on Rails
  • Active Model Serializer
• Database
  • PostgreSQL
• Authorization/Authentication
  • JWT
  • BCrypt
• Web Sockets
  • Action Cable

Typing-Royale's API is built with Ruby on Rails, utilizing JWT and BCrypt for security, and PostgreSQL for its database. ActionCable is utilized to allow for real-time progress updates between players.

Installation

Clone the repo and CD inside the directory
npm install
npm start

Make sure to visit the repo for the backend and follow those instructions as well.

Contributing

Pull requests are always welcome! Please make sure that your PR is well-scoped.

Shane Lonergan 💻 🚇 🐛💡

Sukrit Walia 💻 🚇 🐛💡

License

MIT © Shane Lonergan & Sukrit Walia