Type Fall

A Peculiar Typing Game

---

🔗 Quick Links

• 🚀 Getting Started
  • ⚙️ Installation
  • 🤖 Running Type Fall
• 🤝 Contributing
• 📄 License

📍 Screenshot

🚀 Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

• Node.js: version 20.11.0 or later
• Bun (optional): version 1.0.25 or later

⚙️ Installation

1. Clone the src repository:

git clone https://github.com/martinval11/type-fall

2. Change to the project directory:

cd type-fall

3. Install the dependencies:

$ bun install # or npm install

🤖 Running Type Fall

Use the following command to start the project:

$ bun dev

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.
• Report Issues: Submit bugs found or log feature requests for Src.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine using a Git client.

   git clone https://github.com/martinval11/type-fall

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

---

📄 License

This project is protected under the MIT License. For more details, refer to the LICENSE file.