noxlumina / small-games

Small application featuring a few games that implement algorithms

Small Games

Small Games is a web application featuring various mini-games that implement fundamental algorithmic concepts. The application is designed as a front-end only solution, avoiding API calls for speed optimization and ensuring offline functionality. Additionally, it is built as a Progressive Web App (PWA), providing a responsive user interface for both mobile and desktop devices. PWAs also offer the convenience of direct installation on supported devices.

Features

• Algorithmic Mini-Games: Explore and engage with small games designed to illustrate fundamental algorithmic principles.

• Front-End Focus: The application operates entirely on the front-end, eliminating the need for backend API calls to enhance speed and enable offline usage.

• PWA Compatibility: As a Progressive Web App, Small Games ensures a responsive and seamless experience across various devices. Users can install the application directly on their devices for quick access.

Technologies Used

• Preact CLI: Leveraging the Preact CLI for the development of the application, ensuring a streamlined and efficient workflow.

• Vercel Deployment: Utilizing Vercel as the server for deployment, enabling easy and efficient hosting of the application.

Usage

Local Development

1. Clone the repository.

   git clone https://github.com/Noxlumina/small-games.git

2. Navigate to the project directory.

   cd small-games

3. Install dependencies.

   npm install

4. Run the application locally.

   npm run dev

   The application will be accessible at http://localhost:8080.

Deployment

The application is automatically deployed on Vercel. Visit the live version at Small Games.

Contribution

Contributions to Small Games are welcome! Feel free to submit issues or pull requests.

CLI Commands

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# test the production build locally
npm run serve

# run tests with jest and enzyme
npm run test

For detailed explanation on how things work, checkout the CLI Readme.