Skip to content

Commit

Permalink
Merge pull request #44 from wednesday-solutions/feat/documentation
Browse files Browse the repository at this point in the history
feat: Documentation changes
  • Loading branch information
anasnadeemws authored Apr 18, 2024
2 parents 532ee01 + 63d4b81 commit 0232017
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ This repository provides a template for creating and deploying a FastAPI project
- [Run the Project](#6-run-the-project)
- [Advanced Usage](#advanced-usage)
- [Circuit breakers](#circuit-breakers)
- [Configuring Signoz Monitoring Tool](#configuring-signoz-monitoring-tool)
- [Logging with Signoz](#logging-with-signoz)
- [Configuring SigNoz Monitoring Tool](#configuring-signoz-monitoring-tool)
- [Logging with SigNoz](#logging-with-signoz)
- [Database Monitoring Using Percona](#database-monitoring-using-percona)
- [Deploy Service on AWS ECS](#deploy-service-on-aws-ecs)
- [Related Dashboard Links](#related-dashboard-links)
Expand Down Expand Up @@ -86,7 +86,7 @@ This repository provides a template for creating and deploying a FastAPI project
#### Requirements:
- Python 3
- Docker
- mysql
- MySQL

#### 1. Initialize & Setup Environment

Expand Down Expand Up @@ -310,7 +310,7 @@ To monitor your database using Percona, follow these steps:
- Choose MySQL as the service you want to monitor.
7. **Provide Database Details:**
- Enter the hostname, username, password, and any other necessary environment variables required to connect to your MySQL database.
- Enter the hostname, username, password and any other necessary environment variables required to connect to your MySQL database.
8. **Finish Configuration:**
- Click add service.
Expand Down Expand Up @@ -342,4 +342,4 @@ If you are new to AWS Copilot or you want to learn more about AWS Copilot, pleas
#### Additional Useful scripts
- Tests - scripts/run_tests.sh
- Linting & Formatting - scripts/lint_and_format.sh
- Load tests - scripts/load_tests.sh (Change [locust.conf](https://docs.locust.io/en/stable/configuration.html) accordinly)
- Load tests - scripts/load_tests.sh (Change [locust.conf](https://docs.locust.io/en/stable/configuration.html) accordingly)

1 comment on commit 0232017

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
app
   app.py38380%1–70
app/config
   __init__.py3167%6
   base.py38879%29–36, 54–55
   celery_config.py17170%1–27
   celery_utils.py21210%1–30
   redis_config.py5260%8–9
app/constants
   jwt_utils.py161131%11–23
app/daos
   home.py10550%11–18
   users.py726411%12–136
app/middlewares
   cache_middleware.py51510%1–67
   rate_limiter_middleware.py25250%1–35
   request_id_injection.py17170%1–25
app/models
   __init__.py330%1–5
   users.py27270%1–38
app/routes
   __init__.py12120%1–15
app/routes/cache_router
   __init__.py330%1–5
   cache_samples.py12120%1–18
app/routes/celery_router
   __init__.py330%1–5
   celery_samples.py12120%1–17
app/routes/home
   __init__.py330%1–5
   home.py33330%1–45
app/routes/users
   __init__.py330%1–5
   users.py38380%1–57
app/schemas/users
   users_request.py42420%1–73
   users_response.py10100%1–14
app/sessions
   db.py53530%1–82
app/tests
   test_basic.py201620%8–34
   test_daos_home.py231057%15–22, 28–37, 41
   test_daos_users.py1109514%19–208
app/utils
   exception_handler.py19190%1–36
   redis_utils.py440%1–7
   slack_notification_utils.py14140%1–32
   user_utils.py25250%1–36
app/wrappers
   cache_wrappers.py19190%1–24
TOTAL81871612% 

Tests Skipped Failures Errors Time
2 0 💤 0 ❌ 2 🔥 0.517s ⏱️

Please sign in to comment.