Merge pull request #16 from Desunovu/dev

new features

Author: Desunovu

.env.development

@@ -0,0 +1,20 @@
+### FASTAPI BACKEND
+
+# blogapp secret key
+FASTAPI_SECRET_KEY=someSecretKey
+# chatgpt api key, could be empty if using neuroapi or alternative
+FASTAPI_CHATGPT_API_KEY=someApiKey
+# chatgpt alternative base url, should be empty if base should be original
+FASTAPI_CHATGPT_ALTERNATIVE_BASE=https://neuroapi.host/v1
+# blogapp mode, efforts on how .env file is loading and etc
+FASTAPI_APP_MODE=DEV
+# enables creation of test users (Admin, Author, Reader)
+FASTAPI_CREATE_TEST_USERS=True
+# set logging level
+FASTAPI_LOGGING_LEVEL=DEBUG
+
+FASTAPI_MONGODB_URL=mongodb://localhost:27017
+FASTAPI_MONGODB_DATABASE=blogdatabase
+
+### VITE VUE FRONTEND
+VITE_API_URL="http://localhost:8000"

.env.development.example

@@ -0,0 +1,24 @@
+# FASTAPI BACKEND
+
+# blogapp secret key
+FASTAPI_SECRET_KEY=someSecretKey
+# chatgpt api key, could be empty if using neuroapi or alternative
+FASTAPI_CHATGPT_API_KEY=someApiKey
+# chatgpt alternative base url, should be empty if base should be original
+FASTAPI_CHATGPT_ALTERNATIVE_BASE=https://neuroapi.host/v1
+# blogapp mode, efforts on how .env file is loading and etc
+FASTAPI_APP_MODE=DEV
+# enables creation of test users (Admin, Author, Reader)
+FASTAPI_CREATE_TEST_USERS=True
+# set logging level
+FASTAPI_LOGGING_LEVEL=DEBUG
+
+FASTAPI_MONGODB_URL=mongodb://mongodb:27017
+FASTAPI_MONGODB_DATABASE=blogdatabase
+
+### VITE VUE FRONTEND
+VITE_API_URL="/api"
+
+## MONGO
+#MONGO_INITDB_ROOT_USERNAME:
+#MONGO_INITDB_ROOT_PASSWORD:

.env.production

@@ -4,7 +4,9 @@ venv/
 *.pyc
 
 # env
-*.env
+*.env.*
+!.env.development.example
+!.env.production.example
 
 # Logs
 logs
@@ -34,3 +36,4 @@ coverage
 *.njsproj
 *.sln
 *.sw?
+test.py

.env.production.example

@@ -10,16 +10,17 @@ This project is an educational project for developing a blog using Fast API, Vue
 - **Backend Web Framework**: [FastAPI](https://fastapi.tiangolo.com/)
 - **Database**: MongoDB (used with  [Beanie ODM](https://beanie-odm.dev/))
 - **Frontend Web Framework**: Vue.js (with [Quasar](https://quasar.dev/), [Pinia](https://pinia.vuejs.org/), [OpenAPI Typescript Codegen](https://github.com/ferdikoomen/openapi-typescript-codegen))
-- **Honorable mention**:  OAuth 2.0 JWT Bearer Flow, Nginx
+- **Honorable mention**:  OAuth 2.0 JWT Bearer Flow, Nginx, Chat completions API
 
 ## Project Functionality
 1. **Registration and Authentication**: Users can register and authenticate using OAuth 2.0 JWT.
 2. **Profile Management**: Users can manage their profiles, including changing passwords and updating information. Administrators can also manage users.
-3. **Blog Management**: Users can create, edit, and delete blog articles.
+3. **Blog Management**: Authors can create, edit, and delete blog articles.
 4. **Viewing Articles**: Articles can be viewed as a list and in detail. Pagination and sorting are supported for displaying a large number of articles.
 5. **Tags and Filters**: Articles can be filtered by tags, and users can add tags to articles.
 6. **Search**: Search for articles using keywords.
 7. **Comments**: Users can add comments and reply to them.
+8. **Article Generation**: Admins can generate articles using the OpenAI chat completion API.
 
 
 ## Installation and Local Setup
@@ -31,19 +32,39 @@ To run this project locally, you can use Docker Compose. Make sure you have Dock
    git clone https://github.com/Desunovu/fastapi-vue-blog.git
    cd fastapi-vue-blog
    ```
-2. Open the `.env.production` file located in the project's root directory using a text editor. Set the `SECRET_KEY` variable in this file to a secure secret key for your application. For example:
+   
+
+2. Rename the example environment files located in the project's root directory:
+   - Rename `.env.production.example` to `.env.production`
+   - Rename `.env.development.example` to `.env.development`
+
+
+3. Open the newly created .env.production and .env.development files using a text editor. In these files, you can customize the variables according to your preferences. For example:
 
    ```dotenv
-   SECRET_KEY=mysecretkey
+   FASTAPI_SECRET_KEY=mysecretkey
+   FASTAPI_CHATGPT_ALTERNATIVE_BASE=https://neuroapi.host/v1
+   FASTAPI_CHATGPT_API_KEY=someapikey
+   FASTAPI_CREATE_TEST_USERS=true
+   FASTAPI_LOGGING_LEVEL=debug
    ```
-   Ensure that the SECRET_KEY value is kept secret and not shared publicly.
 
 
-3. Build and start the application containers using Docker Compose:
+4. Build and start the application containers using Docker Compose. You can specify profiles using the --profile argument as follows:
+   - To deploy the full application stack, use:
+   ```bash
+   docker-compose --profile full-deploy up --build
+   ```
+   - To run only the FastAPI and MongoDB containers, use:
+   ```bash
+   docker-compose --profile backend-only up --build
+   ```
+   - To run only the MongoDB container, use:
    ```bash
-   docker-compose up --build
+   docker-compose --profile mongodb-only up --build
    ```
-   This command will download the necessary Docker images, build the application, and start the containers.
+
+This command will download the necessary Docker images, build the application, and start the containers.
 
 ## Accessing the Application
 - Vue App: http://localhost:8080

.gitignore

@@ -1,12 +1,15 @@
+import logging
 import os
 import time
 from pathlib import Path
 
 from dotenv import load_dotenv
 
-mode = os.getenv("APP_MODE", "development")
-if mode == "development":
-    # Загрузка переменных окружения из файла ".env.development в /backend"
+log = logging.getLogger("blogapp")
+
+mode = os.getenv("FASTAPI_APP_MODE", "DEV")
+if mode == "DEV":
+    # Загрузка переменных окружения из файла ".env.development.example в /backend"
     # Не перезаписывает уже заданные переменные.
     # Переменные для prod устанавливаются в docker-compose.yml
     env_path = os.path.join(
@@ -15,16 +18,21 @@
         ),
         ".env.development",
     )
-    print(f"[DEV MODE] Путь к файлу .env: {env_path}")
+    log.debug(f"[DEV MODE] Путь к файлу .env: {env_path}")
     load_dotenv_result = load_dotenv(dotenv_path=env_path)
-elif mode == "production":
-    print(f"[PROD MODE]")
+elif mode == "PROD":
+    log.debug(f"[PROD MODE]")
+
+# Получение переменных окружения приложения
+FASTAPI_SECRET_KEY = os.getenv("FASTAPI_SECRET_KEY", "")
+
+FASTAPI_CHATGPT_ALTERNATIVE_BASE = os.getenv("FASTAPI_CHATGPT_ALTERNATIVE_BASE", "")
+FASTAPI_CHATGPT_API_KEY = os.getenv("FASTAPI_CHATGPT_API_KEY", "")
 
-# Определение констант из переменных окружения
-SECRET_KEY = os.getenv("SECRET_KEY")
-LOGGING_LEVEL = os.getenv("LOGGING_LEVEL")
-MONGODB_URL = os.getenv("MONGODB_URL", "")
-MONGODB_DATABASE = os.getenv("MONGODB_DATABASE")
+FASTAPI_CREATE_TEST_USERS = os.getenv("FASTAPI_CREATE_TEST_USERS", "DEV")
+FASTAPI_LOGGING_LEVEL = os.getenv("FASTAPI_LOGGING_LEVEL", "DEBUG")
+FASTAPI_MONGODB_URL = os.getenv("FASTAPI_MONGODB_URL", "")
+FASTAPI_MONGODB_DATABASE = os.getenv("FASTAPI_MONGODB_DATABASE", "")
 
 # Прочие константы
 ALGORITHM = "HS256"
@@ -38,3 +46,10 @@
 LOG_FORMAT: str = "%(levelprefix)s | %(asctime)s | %(message)s"
 LOGS_DIR_PATH: Path = BACKEND_DIR_PATH / "logs"
 LOG_FILE_PATH: Path = LOGS_DIR_PATH / f"""{time.strftime("%Y%m%d-%H%M%S")}.log"""
+
+# Аватары пользователей
+DEFAULT_AVATAR_URL: str = "https://cdn-icons-png.flaticon.com/512/149/149071.png"
+AVATAR_PROVIDER_URL: str = "https://cdn-icons-png.flaticon.com"
+
+# Параметры статей
+ARTICLE_MAX_LENGTH: int = 10000

README.md

@@ -1,17 +1,17 @@
 from beanie import init_beanie
 from motor.motor_asyncio import AsyncIOMotorClient
 
-from ..config import MONGODB_URL, MONGODB_DATABASE
+from ..config import FASTAPI_MONGODB_URL, FASTAPI_MONGODB_DATABASE
 from ...modules.articles.models import ArticleDocument
 from ...modules.comments.models import CommentDocument
 from ...modules.users.models import UserDocument
 
 
 # Init beanie ODM
 async def init_odm():
-    mongo_client = AsyncIOMotorClient(MONGODB_URL)
+    mongo_client = AsyncIOMotorClient(FASTAPI_MONGODB_URL)
     await init_beanie(
-        database=mongo_client[MONGODB_DATABASE],
+        database=mongo_client[FASTAPI_MONGODB_DATABASE],
         document_models=[
             ArticleDocument,
             UserDocument,

backend/blogapp/core/config.py

@@ -2,7 +2,13 @@
 
 from pydantic import BaseModel
 
-from .config import LOGS_DIR_PATH, LOG_FILE_PATH, LOGGING_LEVEL, LOG_FORMAT, LOGGER_NAME
+from .config import (
+    LOGS_DIR_PATH,
+    LOG_FILE_PATH,
+    FASTAPI_LOGGING_LEVEL,
+    LOG_FORMAT,
+    LOGGER_NAME,
+)
 
 
 # From https://stackoverflow.com/questions/63510041/adding-python-logging-to-fastapi-endpoints-hosted-on-docker-doesnt-display-api
@@ -25,9 +31,14 @@ class LogConfig(BaseModel):
             "formatter": "default",
             "filename": LOG_FILE_PATH,
         },
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "default",
+            "stream": "ext://sys.stdout",
+        },
     }
     loggers: dict = {
-        LOGGER_NAME: {"handlers": ["file"], "level": LOGGING_LEVEL},
+        LOGGER_NAME: {"handlers": ["file", "console"], "level": FASTAPI_LOGGING_LEVEL},
     }
 
 

backend/blogapp/core/database/mongodb.py

@@ -16,6 +16,7 @@ class UserBase(ABC, BaseModel):
     created_at: datetime | None
     updated_at: datetime | None
     password_hash: str | None
+    avatar_url: str | None
 
 
 class TokenResponseBody(BaseModel):