Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 2.64 KB

README.md

File metadata and controls

74 lines (48 loc) · 2.64 KB
Raw

I Know the Maths

A competitive, real-time math problem-solving game built with React and serverless architecture. Players can join a game, solve dynamically generated math problems, and compete for the highest score. The game utilizes serverless functions to manage game sessions and high scores, employs JWT authentication for secure user identification, and features a responsive design for an engaging user experience.

Key Features

  • Real-Time Gameplay: Players can join ongoing games and compete in real-time to solve math problems as quickly and accurately as possible.
  • High Score Leaderboard: Players can view the leaderboard to see how they rank against others, with high scores stored and managed using serverless functions and Airtable.
  • Authentication: Secure user authentication is provided by Auth0, ensuring that only registered players can access the game and save their scores.
  • Responsive Design: The game is styled using styled-components, providing a consistent and enjoyable experience across various devices.

Tech Stack

  • Frontend: React, styled-components
  • Backend: Netlify Functions, Airtable
  • Authentication: Auth0

Project Overview

In this project, I've developed a real-time math problem-solving game using React for the frontend and serverless architecture for the backend. The game challenges players to solve math problems accurately and quickly, with their scores being saved and displayed on a global leaderboard. Leveraging serverless functions hosted on Netlify allows the game to handle multiple concurrent players without a traditional server setup. Additionally, the integration of Auth0 for authentication ensures that players' scores are securely associated with their accounts.

Getting Started

Prerequisites

  • Node.js
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/LouisC00/Serverless-React-Maths-Game.git

  2. Navigate to the project directory:

    cd Serverless-React-Maths-Game

  3. Install dependencies:

    npm install

    or

    yarn install

  4. Start the development server:

    netlify dev

Deployment

This project is deployed on Netlify. To deploy your own instance, follow these steps:

  1. Push your code to a GitHub repository.
  2. Connect your GitHub repository to Netlify.
  3. Set up build commands and publish directory in Netlify.
  4. Deploy your site.

Contributing

Contributions are welcome! If you have any ideas or improvements, feel free to fork the repository and submit a pull request.

License

This project is licensed under the MIT License