diff --git a/README.md b/README.md index 3d28e80..910d225 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,4 @@ ## Backend Docs: -[Backend](./docs/back.md) +[Backend](./docs/api.md) diff --git a/docs/api.md b/docs/api.md index e69de29..aa3fa77 100644 --- a/docs/api.md +++ b/docs/api.md @@ -0,0 +1,3 @@ +# API + +API documentation diff --git a/docs/apiDocs/apiBuilds.md b/docs/apiDocs/apiBuilds.md index e69de29..6f54187 100644 --- a/docs/apiDocs/apiBuilds.md +++ b/docs/apiDocs/apiBuilds.md @@ -0,0 +1,6 @@ +## Todo Lists + +1. Endpoint uuid must be imported from a common folder +2. Auth Service must be seperated from application checkers service even though it serves values from redis +3. Initial services are not functioning well enough +4. ApiResponse and SystemResponse must be seperated diff --git a/docs/apiDocs/apiControllers.md b/docs/apiDocs/apiControllers.md index e69de29..e58f75c 100644 --- a/docs/apiDocs/apiControllers.md +++ b/docs/apiDocs/apiControllers.md @@ -0,0 +1,9 @@ +# Providers + +- Email Provider + +- Mongo Provider + +- Postgres Provider + +- Redis Provider diff --git a/docs/apiDocs/apiInitializer.md b/docs/apiDocs/apiInitializer.md index e69de29..22acfdd 100644 --- a/docs/apiDocs/apiInitializer.md +++ b/docs/apiDocs/apiInitializer.md @@ -0,0 +1,3 @@ +# Initializers of API + +Main components that are need to start API diff --git a/docs/apiDocs/apiMiddlewares.md b/docs/apiDocs/apiMiddlewares.md index e69de29..a0ff130 100644 --- a/docs/apiDocs/apiMiddlewares.md +++ b/docs/apiDocs/apiMiddlewares.md @@ -0,0 +1,5 @@ +# Middlewares + +- Token Middleware : between request and response checks token is valid or not + + diff --git a/docs/apiDocs/apiModules.md b/docs/apiDocs/apiModules.md index e69de29..1d3ffcf 100644 --- a/docs/apiDocs/apiModules.md +++ b/docs/apiDocs/apiModules.md @@ -0,0 +1,4 @@ +# Modules + +Modules that are created from any controllers that are implmented inside API + diff --git a/docs/apiDocs/apiValidations.md b/docs/apiDocs/apiValidations.md index e69de29..2340fe5 100644 --- a/docs/apiDocs/apiValidations.md +++ b/docs/apiDocs/apiValidations.md @@ -0,0 +1,3 @@ +# Validations + +Validations that are used inside API endpoints diff --git a/docs/frontDocs/api_env.env b/docs/apiDocs/api_env.env similarity index 100% rename from docs/frontDocs/api_env.env rename to docs/apiDocs/api_env.env diff --git a/docs/frontDocs/pyproject.toml b/docs/apiDocs/pyproject.toml similarity index 100% rename from docs/frontDocs/pyproject.toml rename to docs/apiDocs/pyproject.toml diff --git a/docs/apiDocs/schemas.md b/docs/apiDocs/schemas.md index e69de29..d3d9c84 100644 --- a/docs/apiDocs/schemas.md +++ b/docs/apiDocs/schemas.md @@ -0,0 +1,3 @@ +# Schemas + +Database Schemas that are used inside API endpoints diff --git a/docs/bankServicesDocs/bank-services-docker-compose.yml b/docs/bankServicesDocs/bank-services-docker-compose.yml new file mode 100644 index 0000000..144cd86 --- /dev/null +++ b/docs/bankServicesDocs/bank-services-docker-compose.yml @@ -0,0 +1,129 @@ +services: + email_service: + container_name: email_service + build: + context: . + dockerfile: BankServices/EmailService/Dockerfile + networks: + - bank-services-network + environment: + - MAILBOX=bilgilendirme@ileti.isbank.com.tr + - MAIN_MAIL=karatay.berkay@gmail.com + - INFO_MAIL=mehmet.karatay@hotmail.com + - EMAIL_HOST=10.10.2.34 + - EMAIL_USERNAME=isbank@mehmetkaratay.com.tr + - EMAIL_PASSWORD=system + - EMAIL_PORT=993 + - EMAIL_SEND_PORT=587 + - EMAIL_SLEEP=60 + - AUTHORIZE_IBAN=4245-0093333 + - REDIS_HOST=10.10.2.15 + - REDIS_PORT=6379 + - REDIS_PASSWORD=your_strong_password_here + restart: unless-stopped + volumes: + - tempory-email-service:/tmp + logging: + driver: "json-file" + options: + max-size: "10m" + max-file: "3" + + parser_service: + container_name: parser_service + build: + context: . + dockerfile: BankServices/ParserService/Dockerfile + networks: + - bank-services-network + environment: + - REDIS_HOST=10.10.2.15 + - REDIS_PORT=6379 + - REDIS_PASSWORD=your_strong_password_here + restart: unless-stopped + logging: + driver: "json-file" + options: + max-size: "10m" + max-file: "3" + + writer_service: + container_name: writer_service + build: + context: . + dockerfile: BankServices/WriterService/Dockerfile + networks: + - bank-services-network + environment: + - REDIS_HOST=10.10.2.15 + - REDIS_PORT=6379 + - REDIS_PASSWORD=your_strong_password_here + - DB_HOST=10.10.2.14 + - DB_PORT=5432 + - DB_USER=postgres + - DB_PASSWORD=password + - DB_NAME=postgres + restart: unless-stopped + logging: + driver: "json-file" + options: + max-size: "10m" + max-file: "3" + + routine_email_service: + container_name: routine_email_service + build: + context: . + dockerfile: BankServices/RoutineEmailService/Dockerfile + entrypoint: ["/entrypoint.sh"] + networks: + - bank-services-network + environment: + - EMAIL_HOST=10.10.2.34 + - EMAIL_USERNAME=karatay@mehmetkaratay.com.tr + - EMAIL_PASSWORD=system + - EMAIL_PORT=587 + - EMAIL_SEND=1 + - DB_HOST=10.10.2.14 + - DB_PORT=5432 + - DB_USER=postgres + - DB_PASSWORD=password + - DB_NAME=postgres + restart: unless-stopped + logging: + driver: "json-file" + options: + max-size: "10m" + max-file: "3" + + sender_service: + container_name: sender_service + build: + context: . + dockerfile: BankServices/SenderService/Dockerfile + networks: + - bank-services-network + environment: + - EMAIL_HOST=10.10.2.34 + - EMAIL_USERNAME=karatay@mehmetkaratay.com.tr + - EMAIL_PASSWORD=system + - EMAIL_PORT=587 + - EMAIL_SEND=1 + - DB_HOST=10.10.2.14 + - DB_PORT=5432 + - DB_USER=postgres + - DB_PASSWORD=password + - DB_NAME=postgres + restart: unless-stopped + logging: + driver: "json-file" + options: + max-size: "10m" + max-file: "3" + +networks: + bank-services-network: + driver: bridge + +volumes: + tempory-email-service: