Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maxime-fleury authored Mar 17, 2024
1 parent db6d2de commit 0637691
Showing 1 changed file with 41 additions and 11 deletions.
52 changes: 41 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,41 @@
# random-list
* Make list of X players for Y teams easly
* Made using github copilot and boostrap 5.2
* You can add players, generate Y teams, remove players, change numbers of teams.
* TO DO:
* SEPARATE HTML AND CSS
* CLEAN CODE
* FIX BUG
* EDIT ERROR MESSAGE TO BE LESS ANNOYING
* ADD DEFAULT PLAYER LIST BASED ON WHAT PEOPLE TYPED PREVIOUSLY (using <data list>, and internal storage)
* SAVE NAMES ALREADY TYPED BEFORE
# Random List Generator

Random List Generator is a simple web application designed to help you organize players into teams effortlessly. It's built using GitHub Copilot and Bootstrap 5.2, ensuring a seamless experience.

## Features

- **Create and Manage Teams:** Easily generate teams by specifying the number of players and teams.
- **Dynamic Player Management:** Add, remove, or change player names on the fly.
- **Error Handling:** Receive helpful error messages to guide you when inputting invalid data.
- **Responsive Design:** Enjoy a responsive layout that adapts to various screen sizes.

## To-Do List

- **Separate HTML and CSS:** Enhance code maintainability by separating HTML and CSS files.
- **Clean Code:** Optimize and refactor code for better readability and efficiency.
- **Bug Fixes:** Address any existing bugs to ensure smooth functionality.
- **Improved Error Messages:** Enhance error messages to be more user-friendly.
- **Save Previous Inputs:** Implement functionality to save previously entered player names.

## Deployment

You can access the application deployed on GitHub Pages [here](https://maxime-fleury.github.io/random-list/).

## Usage

1. Enter the desired number of teams and players.
2. Add player names using the "Ajouter un joueur" button.
3. Click "Générer" to randomly allocate players into teams.
4. Teams will be displayed below with player names listed accordingly.

## Development

This project can be further improved and contributions are welcome. Feel free to fork the repository and submit pull requests.

## Author

This project was created by [Maxime Fleury](https://github.com/maxime-fleury).

## License

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

0 comments on commit 0637691

Please sign in to comment.