https://github.com/arkaung/tictactoe
Simple Tic Tac Toe app written in Python
https://github.com/arkaung/tictactoe
Last synced: 3 months ago
JSON representation
Simple Tic Tac Toe app written in Python
- Host: GitHub
- URL: https://github.com/arkaung/tictactoe
- Owner: ArkAung
- License: mit
- Created: 2023-04-01T23:58:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-02T06:27:37.000Z (over 3 years ago)
- Last Synced: 2025-01-18T17:50:04.657Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Tic Tac Toe
A simple Tic Tac Toe game built with Python and Tkinter. This repo is meant to demonstrate how to structure a typical project such as: project directory structure, unit tests, instructive README to run, test and build, Makefile to facilitate running, building and testing the project, project depedency management and CI workflow.
## Table of Contents
- [Getting Started](#getting-started)
- [Running the Application](#running-the-application)
- [Building the Application](#building-the-application)
- [Running Tests](#running-tests)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
To get started with this project, you should have Python 3.7 or higher and Poetry installed on your machine.
1. Clone the repository:
```bash
git clone https://github.com//tictactoe.git
cd tictactoe
```
2. Install the project dependencies using Poetry:
```bash
poetry install
```
## Running the Application
To run the Tic Tac Toe game, you can use the run Makefile target:
```bash
make run
```
Alternatively, you can run the game directly using Python:
```bash
poetry run python -m tictactoe.tictactoe
```
## Building the Application
To build the Tic Tac Toe game into a standalone binary, you can use the build Makefile target:
```bash
make build
```
This will generate a standalone binary in the dist directory.
## Running Tests
To run the unit tests for the Tic Tac Toe game, you can use the test Makefile target:
```bash
make test
```
Alternatively, you can run the tests directly using Python:
```bash
poetry run python -m unittest discover tests
```
## Contributing
We welcome contributions from the community. To contribute to this project, please follow these steps:
1. Fork the repository on GitHub.
2. Clone your forked repository:
```bash
git clone https://github.com//tictactoe.git
cd tictactoe
```
3. Create a new branch for your changes:
```bash
git checkout -b feature/
```
4. Make your changes and commit them using Conventional Commits format:
```bash
git add .
git commit -m "(): "
```
5. Push your branch to your forked repository:
```bash
git push -u origin feature/
```
6. Create a pull request (PR) to merge your branch into the main branch.
Please ensure that your commit messages follow the Conventional Commits specification to ensure that the project conforms to semantic versioning.
## License
This project is licensed under the MIT License - see the LICENSE file for details.