https://github.com/mandaputtra/flip-a-match

A simple game to find a matching color
https://github.com/mandaputtra/flip-a-match

Last synced: about 2 months ago
JSON representation

A simple game to find a matching color

• Host: GitHub
• URL: https://github.com/mandaputtra/flip-a-match
• Owner: mandaputtra
• Created: 2024-03-31T15:38:16.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-04-03T00:13:39.000Z (10 months ago)
• Last Synced: 2024-10-14T12:40:52.338Z (3 months ago)
• Language: TypeScript
• Homepage: https://flip-a-match.netlify.app/
• Size: 71.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Flip A Match

Simple game to find matching colors. Want to help develop it? Here's how!

## Contributing

This project uses [Vite](https://vitejs.dev/) with [Typescript](https://www.typescriptlang.org/). Let's get you set up to contribute:

**Requirements:**

* **[Node.js](https://nodejs.org/en):** This is the foundation for running the project.

* **[Git](https://git-scm.com/downloads):** This is a version control system for tracking changes in your code.

* **[pnpm](https://pnpm.io/):** This is a package manager for installing project dependencies.

**Development Process:**

1. **Clone the Repository:** Get a copy of the project's code on your machine using Git. `git clone https://github.com/mandaputtra/flip-a-match`

2. **Install Dependencies:** Once cloned, navigate to the project directory and run `pnpm install` in your terminal to install all the necessary tools the project uses.

3. **Run the App:** With dependencies installed, you can start the development server by running `pnpm dev` in your terminal. This will launch the game in your browser, ready for testing and development.

**Deployment:**

Ready to share your creation with the world? Here's how to deploy:

1. **Build for Deployment:** Run `pnpm build` in your terminal. This creates an optimized `dist` folder containing the production-ready files.

2. **Host on Netlify:** Drag and drop the `dist` folder to [Netlify Drop](https://app.netlify.com/drop) for a quick and easy deployment option (You need to create account). Alternatively, you can use any static site hosting platform of your choice.

**Contributing Your Code:**

Excited to add your features or fix bugs? Here's how to contribute code:

1. **Fork the Repository:** Create your own copy of the project on GitHub using the "Fork" button. This allows you to make changes without affecting the original codebase.

2. **Make a Branch and Pull Request:** Create a new branch for your specific changes and then submit a pull request to propose your modifications to the main project.

3. **Pull Request Title:** Follow [standard naming conventions](https://namingconvention.org/git/pull-request-naming.html) for clear and concise pull request titles.

**Example Pull Request Title:**

To contribute code to this repository, please [fork this repository](https://github.com/mandaputtra/flip-a-match/fork). After that make a branch and pull request with your changes. 

Pull request title follow standard rules that can be [read here](https://namingconvention.org/git/pull-request-naming.html).

Example : 

```txt

#28 - Fix bug in end-game logic

```

(Replace #28 with the actual issue number if applicable. Otherwise, describe your changes in the title).

## Roadmap

* Improve animations (smooth flip, flip all cards on enter)

* Add levels/difficulties (more tiles, more selections)

* Implement multiplayer using P2P (GunJS)

* Explore TWA (Trusted Web App) for mobile release