Shibumi Store

Welcome to the "Shibumi Store" Project - a high-performance backend for e-commerce platform. Code name is SHIBU.

What is Shibumi?

Shibumi (渋み) (noun) or Shibui (渋い) (adjective) are Japanese words which refer to a particular aesthetic or beauty of simple, subtle, and unobtrusive beauty. Shibumi includes the following essential qualities:

• Shibui objects appear to be simple overall, but they include subtle details, such as textures, that balance simplicity with complexity.
• This balance of simplicity and complexity ensures that one does not tire of a shibumi object but constantly finds new meanings and enriched beauty that cause its aesthetic value to grow over the years.
• Shibui objects are not necessarily imperfect or asymmetrical, though they can include these qualities.
• Shibumi walks a fine line between contrasting aesthetic concepts such as elegant and rough or spontaneous and restrained.

Technology Stack

• FastAPI: Utilizing the FastAPI web framework for high-speed asynchronous API development.
• MongoDB with Motor: Efficient and asynchronous data storage.
• Authentication and Security: Secure user authentication with pyjwt and password hashing using Argon2.
• Data Validation and Serialization: Robust data validation and serialization using Pydantic.
• Date and Time Handling: Efficient date and time handling using the Arrow library.
• Testing: Comprehensive testing suite with Pytest and Pytest-asyncio for reliable code testing.
• Database Migrations: Smooth management of database schema changes using MongoDB Migrations.

Code Cleanliness

Maintaining clean and readable code is essential. The project uses Ruff as a code formatter and linter, MyPy for static type checking, and SonarQube for additional code quality analysis.

Project Structure

The project is organized with the following directory structure:

.
├── .github/                                   # GitHub-related configurations
│   └── workflows/                             # GitHub Actions workflows
│       └── ci.yml                             # Continuous Integration workflow
├── app/                                       # Main application code
│   ├── api/
│   │   ├── v1/                                # API version 1
│   │   │   ├── dependencies                   # Domain dependencies for determination and validation (using validators) HTTP request data
│   │   │   │   ├── __init__.py
│   │   │   │   ├── auth.py
│   │   │   │   ├── user.py
│   │   │   │   └── ...
│   │   │   ├── models                         # Pydantic models
│   │   │   │   ├── __init__.py
│   │   │   │   ├── auth.py
│   │   │   │   ├── user.py
│   │   │   │   └── ...
│   │   │   ├── repositories                   # Database entities interactions
│   │   │   │   ├── __init__.py
│   │   │   │   ├── user.py
│   │   │   │   └── ...
│   │   │   ├── routers                        # API route handlers
│   │   │   │   ├── __init__.py
│   │   │   │   ├── auth.py
│   │   │   │   ├── health.py
│   │   │   │   ├── user.py
│   │   │   │   └── ...
│   │   │   ├── validators                     # Validators for HTTP request data
│   │   │   │   ├── __init__.py
│   │   │   │   ├── auth.py
│   │   │   │   ├── user.py
│   │   │   │   └── ...
│   │   │   ├── services                       # API for interactions with entities 
│   │   │   │   ├── __init__.py
│   │   │   │   ├── user.py
│   │   │   │   └── ...
│   │   │   ├── __init__.py                    # Collects API routes
│   │   │   └── constants.py                   # Constants for API v1
│   │   └── __init__.py
│   ├── loaders                                # Data loading modules from different sources (environment, JSON files, etc.)
│   │   └── __init__.py
│   ├── services                               # External services used by application
│   │   ├── mongo                              # MongoDB service
│   │   │   ├── __init__.py
│   │   │   ├── client.py                      # MongoDB client handler
│   │   │   ├── constants.py                   # MongoDB constants
│   │   │   ├── service.py                     # MongoDB service (facade used in entity repositories)
│   │   │   └── transaction_manager.py         # MongoDB transaction manager
│   │   ├── ...
│   │   ├── __init__.py                        # Collects all external services
│   │   └── base.py                            # Base service abstract class
│   ├── tests/                                 # Unit tests and fixtures
│   │   ├── api
│   │   │   ├── v1                             # Unit tests for API routes
│   │   │   │   ├── __init__.py
│   │   │   │   ├── test_auth.py
│   │   │   │   ├── test_health.py
│   │   │   │   ├── test_user.py
│   │   │   │   └── ...
│   │   │   └── __init__.py
│   │   ├── fixtures                           # JSON file fixtures handler
│   │   │   ├── json                           # JSON files with entities data
│   │   │   │   ├── users.json
│   │   │   │   └── ...
│   │   │   ├── __init__.py
│   │   │   └── manager.py                     # JSON files fixture manager
│   │   ├── __init__.py
│   │   └── constants.py                       # Constants for unit tests
│   ├── utils/                                 # Utility modules
│   │   ├── __init__.py
│   │   ├── jwt.py                             # JWT handler
│   │   ├── metas.py                           # Custom metaclasses
│   │   ├── password.py                        # Password handler
│   │   ├── pydantic.py                        # Custom pydantic utilities
│   │   └── token.py                           # Verification token component
│   ├── __init__.py
│   ├── app.py                                 # Configures and runs FastAPI application
│   ├── constants.py                           # Application level constants
│   ├── exceptions.py                          # Custom application exceptions
│   └── settings.py                            # Defines application settings
├── migrations/                                # MongoDB migration scripts
│   ├── 20231231132337_create_users_username_index.py
│   └── ...
├── .gitignore                                 # Gitignore file to specify ignored files and directories
├── docker-compose.yml                         # docker-compose file for application
├── Dockerfile                                 # Application Dockerfile
├── LICENSE                                    # License information for the project
├── poetry.lock                                # Poetry lock file specifying exact package versions
├── pyproject.toml                             # Project configuration file
├── README.md                                  # Project README file
├── sonar-project.properties                   # Configuration file for SonarQube code quality analysis
└── tasks.py                                   # Application cli

Getting Started

1. Clone the repository:

git clone https://github.com/valentyn-malenchak/shibumi-store.git

2. Add environment variables in docker-compose marked with appropriate comments.

3. Build the application container:

docker build -t shibumi-store:latest .

or

invoke build

4. Run the application:

docker-compose up -d

or

invoke compose

Check out useful cli commands

License

This project is licensed under the MIT License - see the LICENSE file for details.