/Memorization-Tool-Go

HS Memorization Tool project with Go solution using GORM

Primary LanguagePython

Memorization-Tool-Go

Hyperskill Memorization Tool project from the Python/Flask track, reimplemented in Go using GORM.

Requirements:

Before you get started with the Memorization Tool project, ensure you have the following requirements installed in your machine:

  • Go version 1.21.0+
  • Python 3.10+ (for testing)
  • Make (for automation)

For Windows 🪟 Users:
While you can run individual tests in Windows directly, for a full automated testing experience with make, it's highly recommended to use the Windows Subsystem for Linux (WSL). Follow this guide to set up WSL.

Setting up the project workspace:

  1. Clone the repository and cd into it:
git clone https://github.com/gutyoh/Memorization-Tool-Go.git
cd Memorization-Tool-Go
  1. Directory structure: After cloning the repository, the directory tree should look like this:
Memorization-Tool-Go
├── go.mod
├── go.sum
├── lesson-info.yaml
├── lesson-remote-info.yaml
├── Makefile
├── README.md
├── requirements.txt
├── stage1
│   ├── main.go
│   ├── task.html
│   ├── task-info.yaml
│   ├── task-remote-info.yaml
│   ├── test
│   │   ├── __init__.py
│   │   └── tests.py
│   └── tests.py
├── stage2
│   ├── main.go
│   ├── task.html
│   ├── task-info.yaml
│   ├── task-remote-info.yaml
│   ├── test
│   │   ├── __init__.py
│   │   └── tests.py
│   └── tests.py
├── stage3
│   ├── main.go
│   ├── task.html
│   ├── task-info.yaml
│   ├── task-remote-info.yaml
│   ├── test
│   │   ├── __init__.py
│   │   └── tests.py
│   └── tests.py
└── stage4
    ├── main.go
    ├── task.html
    ├── task-info.yaml
    ├── task-remote-info.yaml
    ├── test
    │   ├── __init__.py
    │   └── tests.py
    └── tests.py
  1. Setup Python Virtual Environment:

Linux 🐧, macOS 🍏, and WSL:

python3 -m venv memo_tool_venv
source memo_tool_venv/bin/activate

Windows 🪟:

python -m venv memo_tool_venv
memo_tool_venv\Scripts\activate
  1. Install the necessary Python packages:
pip install -r requirements.txt

After completing the above steps, below is a picture of how the project directory should look like:

image

Running the project:

Linux 🐧, macOS 🍏, and WSL:

From the root of the project directory, run the project using make:

make

Executing the make command will automatically run tests for each stage (stage1 to stage4).

Windows 🪟:

For Windows users not using WSL, you'll need to manually navigate into each stage and run the tests:

cd stage1
python tests.py

Finally, confirm that the tests pass with Go solutions:

image