Amazeing

[!TIP]

Check it out at amazeing.app/.

Features

• Implements 21+ algorithms for maze creation and traversal.
• Extensive control over algorithm execution (autoplay, iteration history, etc.).
• Paintable grid to create or alter your existing maze.
• Easy import/export feature at any stage of the algorithm execution.
• Statistics tracking during the algorithm execution.
• Learn page with general information and additional resources.
• Available as a Progressive Web App (PWA).

---

Screenshot

---

Support

This has been a passion project of mine which I did not create for profit and it will always remain open source and ad-free.

If you enjoy this project and want to show your appreciation, feel free to:

• Support the project: Ko-fi :coffee:
• Spread the word: Share this project with others!

Contributions

Contributions are welcome! :heart:

To ensure a smooth collaboration, please follow these guidelines:

1. Create an Issue First: If you're planning to work on a feature or bug fix, please create an issue beforehand to discuss it. This helps avoid duplicate efforts and ensures your contribution aligns with the project's direction. Pull Requests without prior discussion have a high chance of not being accepted. (Sorry!)
2. Style Guides:
   • Respect the Angular style guide.
   • Adhere to conventional commits.
3. Code Comments: Only comment when necessary, but always for functions.

There are quite a few TODOs throughout this project that could be good starting points. Feel free to browse existing issues or create a new one to propose an idea.

Note: This project is based on a previous Vue.js project of mine, which was later converted to Angular. You can check out the original Game of Life Vue project here.

---

Project structure

Here is a quick overview of the project structure and where the most important functionality is located.

├── assets                     # Uncompressed source files (images & markdown articles)
├── e2e
│   └── playwright             # E2E UI automation tests
├── src
│   ├── app
│   │   ├── @core              # Singleton services and core logic
│   │   │   ├── algorithm      # Implementation of all maze and pathfinding algorithms
│   │   │   |   ├── classes    # Data structures (HashSet, PriorityQueue, etc.)
│   │   │   │   ├── maze
│   │   │   │   └── path-finding
│   │   │   ├── services
│   │   │   │   ├── algorithm.service.ts  # Standardizes algorithm execution & delegates data for simulation
│   │   │   │   ├── record.service.ts     # Manages algorithm state and iteration history
│   │   │   │   ├── settings.service.ts   # Persists user preferences
│   │   │   │   └── simulation.service.ts # Controls simulation state (play/pause/step, etc.)
│   │   │   └── types                     # Shared interfaces and types
│   │   ├── @shared            # Reusable UI elements and helper logic
│   │   │   ├── components
│   │   │   ├── directives
│   │   │   ├── pipes
│   │   │   └── utils          # Pure utility functions
│   │   ├───learn              # The /learn route and components
│   │   └───simulation         # The /simulation route and components
├── assets                     # Assets for the final bundle (compressed images & compiled frontmatter articles)
├── build-articles.js          # CI: Converts Markdown + Frontmatter into JSON
└── build-version.js           # CI: Injects latest Git tag version into production builds

Development server

Run ng serve for development. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running tests

This project uses Playwright for e2e tests and ensures that the most common use-cases are covered and don't produce errors while executing the algorithms.

More tests could be introduced but there is no way to automatically test for the correctness of the algorithms themselves.

Run locally: npm run test:pw

---

License:

This project is licensed under the MIT License.