Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrevarandas/memoria-leonina

🦁 Memória Leonina is an interactive memory game that celebrates Sporting Clube de Portugal.
https://github.com/andrevarandas/memoria-leonina

football game-development hacktoberfest hacktoberfest2023 javascript memory-challenge memory-game open-source sporting-cp sports vue-3 vuejs

Last synced: 16 days ago
JSON representation

🦁 Memória Leonina is an interactive memory game that celebrates Sporting Clube de Portugal.

Awesome Lists containing this project

README

        

![Memoria Leonina Logo](public/logo.png)

# Memória Leonina

Memória Leonina is an engaging memory game that celebrates Sporting Clube de Portugal by challenging players' memory and knowledge of the club's iconic players. Join us in the world of the lion and test your memory skills while enjoying Sporting's rich history.

## Getting Started

Memória Leonina is built with [Vite](https://vitejs.dev/), a fast web development build tool. To get started, follow the instructions below.

### Prerequisites

Ensure you have Node.js installed on your machine.

### Installation

1. Clone this repository:

```sh
git clone https://github.com/andrevarandas/memoria-leonina.git
```

2. Change to the project directory:

```sh
cd memoria-leonina
```

3. Install dependencies:

```sh
npm install
```

### Development Mode

To run the application in development mode, use the following command:

```sh
npm run dev
```

### Building for Production

To build the application for production, use the following command:

```sh
npm run build
```

### Running in Production

To serve the production build, use the following command:

```sh
npm run serve
```

## Project Structure

The project structure is organized as follows:

- `src/`: Contains the source code of the application.
- `public/`: Contains static assets and HTML templates.
- `dist/`: Contains the production build of the application.

## Contributing

We welcome contributions from the community to enhance Memória Leonina. To contribute:

1. Fork this repository.
2. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name`.
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your fork: `git push origin feature/your-feature-name`.
5. Create a pull request to merge your changes into the `main` branch of this repository.

Please ensure your code follows the project's coding standards and conventions.

## Testing

We value quality assurance, and contributions that improve the test coverage of the application are welcome. To run the tests, use the following command:

```sh
npm run test
```

## Localization

Memória Leonina aims to be inclusive, and we welcome contributions for localization in different languages. If you'd like to help translate the game, please feel free to create a pull request with your changes.

## Accessibility

We are committed to making Memória Leonina accessible to all users. If you encounter or wish to address accessibility issues, please refer to the Accessibility Guide for guidance.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

We look forward to your contributions and hope you enjoy Memória Leonina!

For any questions or issues, please create an issue on the repository.

## Disclaimer

This project is a fan-created game and is not endorsed by or affiliated with Sporting Clube de Portugal.

The player images used in Memória Leonina are sourced from publicly available and freely accessible online resources. We do not claim ownership of these images, and they are used solely for the purpose of enhancing the game's experience.