Table of Contents
This project is a typing game where you can compete with your friends. The goal is to type the code snippets as fast as possible. The game is in real time, so you can see the progress of your friends. The game is also available in multiple languages such as (Typescript, Go).
List of technologies / frameworks used during the project.
To get a local copy up and running follow these simple steps.
The best way to deploy the project is to use docker and docker-compose. You will need to have docker and docker-compose installed on your machine.
Golang is also required to build the backend. Node is required to build the frontend.
You should be in the backend folder to run the following commands.
make buildYou should be in the frontend folder to run the following commands.
bun run devContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Reach me at : gauron.dorian.pro@gmail.com.
Project Link: https://github.com/Michelprogram/magic-scanner.git
This space is a list to resources i found helpful and would like to give credit to.