Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vaagenim/namesoundaliker
Namesoundaliker github repo - daily puzzle game, figure out who or what today's word sounds like
https://github.com/vaagenim/namesoundaliker
assignment docker flask game learning-by-doing wordle
Last synced: about 2 months ago
JSON representation
Namesoundaliker github repo - daily puzzle game, figure out who or what today's word sounds like
- Host: GitHub
- URL: https://github.com/vaagenim/namesoundaliker
- Owner: VaagenIM
- License: mit
- Created: 2024-11-06T08:39:32.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T08:04:31.000Z (about 2 months ago)
- Last Synced: 2024-11-07T08:36:19.441Z (about 2 months ago)
- Topics: assignment, docker, flask, game, learning-by-doing, wordle
- Language: HTML
- Homepage: http://namesoundaliker.it3.iktim.no
- Size: 1.73 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Namesoundaliker README
Welcome to **Namesoundaliker**! Inspired by popular daily word and puzzle games like **Wordle** and **Bandle**, this project lets you try to figure out who or what something sounds like. This README provides instructions on how to set up and run the game locally using Docker.
---
## Table of Contents
1. [Project Overview](#project-overview)
2. [Requirements](#requirements)
3. [Installation and Setup](#installation-and-setup)
4. [Usage](#usage)
5. [Adding More Days](#adding-more-days)
6. [Contributing](#contributing)
7. [License](#license)
---
## Project Overview
This game presents a fresh puzzle every day, automatically refreshed for daily play. Challenges are organized in a straightforward folder structure, allowing for easy extension and customization.
## Requirements
- **Docker**: Make sure Docker is installed on your system. If you don’t have Docker, you can [download it here](https://www.docker.com/get-started).
## Installation and Setup
### Step 1: Clone the Repository
First, clone the repository to your local machine:
```bash
git clone https://github.com/VaagenIM/Namesoundaliker.git
cd gaming-Kliiyu
```
### Step 2: Run the Game with Docker Compose
Use Docker Compose to build and run the game. This will set up the game environment and expose it on localhost:1738.
```bash
docker compose up -d --build
```
After running the command, the game will be accessible at:
```arduino
http://localhost:1738
```
> Note: The first time you run Docker Compose, it may take a few minutes to build the necessary Docker images.
### Usage
Once the application is running, open your browser and navigate to http://localhost:1738. You’ll be greeted with the day’s puzzle, ready to play.
Each day brings a new challenge, but you can also add additional puzzles (see [Adding More Days](#adding-more-days)).
### Adding More Days
To add more daily challenges, follow these steps:
Navigate to the private/days directory: Each puzzle day is stored as a separate folder in this directory.
```arduino
static/
└── days/
├── 1/
├── 2/
└── 3/
```
Create a new folder: Add a new folder inside static/days/. Name the folder according to the day number (e.g., 4).
Follow the file structure: Ensure the new folder follows the same file structure as previous days. Copy the template from another day folder if necessary.
Restart the game: After adding a new day, restart the Docker container to refresh the game content.
```bash
docker compose up -d --build
```
### Contributing
If you’d like to contribute to the project by adding features, improving documentation, or submitting bug fixes, please fork the repository and open a pull request.
### License
This project is licensed under the [MIT License](LICENSE).
Made with ❤️ by Kliiyu and PrettyEpicCat