mundo

module
v0.0.0-...-d01fd15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2024 License: GPL-3.0

README

Mundo - Chinese-English Dictionary Project

Mundo is a simple dictionary application for querying Chinese and English words. It provides functionalities such as word lookup, displaying explanations, and keeping track of query history, enabling users to easily search for words and facilitate learning.

Features

  • Word Lookup: Users can query vocabulary by entering Chinese or English words.
  • Display Explanations: The system returns Chinese or English explanations of words for users to understand their meanings.
  • Query History Logging: The system logs the words users have queried, allowing them to review these words later.

Technology Stack

  • Backend Development Language: Golang
  • Architecture Design: Domain-driven design (DDD) and Clean Architecture
  • Database: SQLite or PostgreSQL
  • Frontend Interface: A simple web interface for interaction with the backend API

Development Process

We will utilize the Scrum methodology to develop the project, breaking down the work into short-term iterative development cycles. Each iteration (Sprint) typically lasts 1 to 4 weeks, during which we will continuously collaborate with the team to improve and refine the project.

How to Use

  1. Install Dependencies: Ensure that Golang environment and relevant libraries are installed on your system.
  2. Set Up the Database: Choose between using SQLite or PostgreSQL, and initialize the database according to the provided script.
  3. Start the Application: Run the backend service and access the frontend interface to begin using Mundo.

Contributions

We welcome contributions in various forms to enhance the project's functionality and reliability. Feel free to submit pull requests, report issues, or provide feedback to help us improve Mundo.

Directories

Path Synopsis
cmd
app
entity
domain/management/biz
Package biz is a generated GoMock package.
Package biz is a generated GoMock package.
domain/management/repo
Package repo is a generated GoMock package.
Package repo is a generated GoMock package.
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL