hng_boilerplate_python_fastapi_web
No description available.
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- cd.dev.yaml
- cd.prod.yaml
- cd.staging.yaml
- ci.yml
- pr-deploy.yml.bkp
- regression-test.yml
- PULL_REQUEST_TEMPLATE.md
- profiles_settings.xml
- Project_Default.xml
- .gitignore
- git_toolbox_blame.xml
- hng_boilerplate_python_fastapi.iml
- hng_boilerplate_python_fastapi_web.iml
- material_theme_project_new.xml
- misc.xml
- modules.xml
- vcs.xml
- .gitkeep
- env.py
- README
- script.py.mako
- __init__.py
- services.py
- account-activated.html
- account-deactivation.html
- account-inactivity.html
- activate-account.html
- activation-link-expired.html
- admin-base.html
- base.html
- contact_us.html
- deactivation-confirmation.html
- email-confirmed.html
- email-verification.html
- email_feedback.html
- faq-feedback.html
- login-notification.html
- new-activation-link.html
- newsletter-subscription.html
- password-reset-complete.html
- profile_recovery_email.html
- request-token.html
- reset-password.html
- signin.html
- squeeze.html
- unsubscribe.html
- waitlists.html
- welcome.html
- __init__.py
- email_sender.py
- google_email.py
- google_oauth_config.py
- __init__.py
- responses.py
- __init__.py
- database.py
- Storage.py
- __init__.py
- client_helpers.py
- config.py
- db_validators.py
- dependencies.py
- email_service.py
- json_response.py
- logger.py
- pagination.py
- send_logs.py
- send_mail.py
- settings.py
- success_response.py
- __init__.py
- permissions.py
- role.py
- role_permissions.py
- user_org_role.py
- __init__.py
- activity_logs.py
- api_status.py
- associations.py
- base_model.py
- billing_plan.py
- blog.py
- bookmark.py
- comment.py
- contact_us.py
- data_privacy.py
- email_template.py
- faq.py
- faq_inquiries.py
- invitation.py
- job.py
- message.py
- newsletter.py
- notifications.py
- oauth.py
- organisation.py
- payment.py
- privacy.py
- product.py
- profile.py
- regions.py
- reset_password_token.py
- sales.py
- squeeze.py
- team.py
- terms.py
- testimonial.py
- token_login.py
- topic.py
- totp_device.py
- user.py
- waitlist.py
- wishlist.py
- __init__.py
- permisions.py
- roles.py
- __init__.py
- activity_logs.py
- analytics.py
- api_status.py
- api_tests.py
- auth.py
- billing_plan.py
- blog.py
- comment.py
- contact.py
- contact_us.py
- dashboard.py
- email_routes.py
- email_template.py
- facebook_login.py
- faq.py
- faq_inquiries.py
- google_login.py
- invitations.py
- job_application.py
- jobs.py
- newsletter.py
- notification.py
- notification_settings.py
- organisation.py
- payment.py
- payment_flutterwave.py
- privacy.py
- product.py
- product_comment.py
- profiles.py
- regions.py
- request_password.py
- settings.py
- sms_twilio.py
- squeeze.py
- stripe.py
- team.py
- terms_and_conditions.py
- testimonial.py
- topic.py
- user.py
- waitlist.py
- wishlist.py
- __init_.py
- permissions.py
- roles.py
- __init__.py
- activity_logs.py
- analytics.py
- api_status.py
- base_schema.py
- blog.py
- comment.py
- contact.py
- contact_us.py
- dashboard.py
- data_privacy.py
- email_schema.py
- email_template.py
- faq.py
- faq_inquiries.py
- google_oauth.py
- invitations.py
- job_application.py
- jobs.py
- newsletter.py
- notification.py
- notification_settings.py
- organisation.py
- payment.py
- plans.py
- privacy_policies.py
- product.py
- product_comment.py
- profile.py
- regions.py
- request_password_reset.py
- role.py
- sms_twilio.py
- squeeze.py
- stripe.py
- team.py
- terms_and_conditions.py
- testimonial.py
- token.py
- topic.py
- totp_device.py
- user.py
- waitlist.py
- wishlist.py
- __init__.py
- permison_service.py
- role_service.py
- __init__.py
- activity_logs.py
- analytics.py
- api_status.py
- api_tests.py
- auth.py
- billing_plan.py
- blog.py
- blog_comment_reply.py
- bookmark.py
- comment.py
- comment_dislike.py
- comment_like.py
- contact.py
- contact_us.py
- data_privacy.py
- email_services.py
- email_template.py
- facebook.py
- faq.py
- faq_inquiries.py
- google_oauth.py
- invite.py
- job_application.py
- jobs.py
- login_notification.py
- newsletter.py
- notification.py
- notification_settings.py
- organisation.py
- payment.py
- privacy_policies.py
- product.py
- product_comment.py
- profile.py
- regions.py
- request_pwd.py
- schedule_payment.py
- sms_twilio.py
- squeeze.py
- stripe_payment.py
- team.py
- terms_and_conditions.py
- testimonial.py
- topic.py
- totp.py
- user.py
- waitlist.py
- waitlist_email.py
- wishlist.py
- __init__.py
- Boilerplate-status-page.postman_collection.json
- __init__.py
- get-pip.py
- org_seed.py
- populate_db.py
- seed.py
- seed2.py
- seed3.py
- __init__.py
- test_create_activity_log.py
- test_delete_activity_log.py
- test_get_a_user_activity_logs.py
- test_get_all_logs.py
- test_analytics_summary.py
- test_line_chart_data.py
- __init__.py
- test_2fa.py
- test_email_verification.py
- test_google_auth.py
- test_magic_link.py
- test_rate_limiting.py
- test_request_pwd_reset.py
- test_signin.py
- test_signup.py
- test_token_auth.py
- test_verify_magic_link.py
- __init__.py
- test_billing_plan.py
- test_delete_billing_plan.py
- test_get_billing_plan.py
- test_stripe.py
- test_update_billing_plan.py
- __init__.py
- delete_blog_test.py
- get_all_blogs_test.py
- test_add_comment.py
- test_archived_blog.py
- test_blog_model_indexing.py
- test_blog_update.py
- test_delete_blog_dislike.py
- test_delete_blog_like.py
- test_dislike_blog_post.py
- test_get_blogs_by_id.py
- test_like_blog_post.py
- test_search_blogs.py
- test_update_blog_comment.py
- __init__.py
- test_save_job.py
- __init__.py
- test_delete_comment.py
- test_dislike_comment.py
- test_fetch_all_comments.py
- test_like_comment.py
- test_reply_comment.py
- test_post_contact_us.py
- test_get_products.py
- __init__.py
- test_add_email_template.py
- test_delete_template.py
- test_fetch_all_templates.py
- test_get_single_template.py
- test_send_email_template.py
- test_update_template.py
- __init__.py
- create_faq_test.py
- delete_faq_test.py
- filter_faq_by_category_test.py
- get_all_faqs_test.py
- get_single_faq_test.py
- update_faq_test.py
- test_faq_inquiries.py
- __init__.py
- test_accept_invitation.py
- test_delete_all_invitations.py
- test_delete_invitation.py
- __init__.py
- test_add_jobs.py
- test_apply_for_job.py
- test_create_job_application.py
- test_delete_jobs.py
- test_fetch_all_jobs.py
- test_filter_jobs.py
- test_get_job.py
- test_update_jobs.py
- test_delete_by_id.py
- test_fetch_all_applications.py
- test_get_single_job_application.py
- __init__.py
- delete_newsletter_test.py
- test_get_single_newsletter.py
- test_newsletter_subscribe.py
- test_newsletter_subscriber_retrieval_pagination.py
- test_newsletter_unsubscribe.py
- test_update_newsletter.py
- __init__.py
- test_delete_notification.py
- test_get_user_nots.py
- test_notification.py
- test_notifications_service.py
- __init__.py
- test_create_notification_settings.py
- test_get_user_notification_settings.py
- test_update_user_notification_settings.py
- __init__.py
- create_organization_test.py
- org_products_test.py
- organization_update_test.py
- test_delete_user_from_organisation.py
- test_export_user_data.py
- test_get_organisation_invitations.py
- test_get_organisation_users.py
- test_flutterwave.py
- test_get_payments_for_current_user.py
- test_payment.py
- __init__.py
- create_privacy_test.py
- delete_privacy_test.py
- get_all_privacy_test.py
- get_single_privacy_test.py
- update_privacy_test.py
- __init__.py
- create_product_test.py
- delete_product_test.py
- test_categories_retrieve.py
- test_delete_category.py
- test_delete_product_comment.py
- test_filter_status.py
- test_get_product_detail.py
- test_get_product_stock.py
- test_new_product_category.py
- test_product_comment.py
- test_product_search.py
- test_restore_category.py
- test_status.py
- update_product_test.py
- __init__.py
- test_create_product_comment.py
- test_update_product_comment.py
- __init__.py
- test_upload_profile_image.py
- test_user_profile.py
- user_update_profile_test.py
- __init__.py
- permissions_test.py
- roles_test.py
- test_get_roles.py
- test_remove_user_from_role.py
- test_role_permissions.py
- test_update_builtin_role.py
- test_update_custom_role.py
- test_update_perms.py
- test_get_data_privacy_setting.py
- test_update_data_privacy_settings.py
- __init__.py
- test_sms_twilio.py
- __init__.py
- test_facebook_auth.py
- test_create_squeeze.py
- test_delete_squeeze.py
- test_fetch_squeeze.py
- test_update_squeeze.py
- test_post_status.py
- __init__.py
- test_admincreate.py
- test_delete_team_by_id.py
- test_get_contact.py
- test_get_team_member_by_id.py
- test_superadmin.py
- test_update_team_member.py
- test_add_team_member.py
- test_get_all_team_members.py
- test_telex_integration.py
- test_create_terms_and_conditions.py
- test_delete_terms_and_conditions.py
- test_get_terms_and_conditions.py
- test_update_terms_and_conditions.py
- __init__.py
- test_create_testimonial.py
- test_fetch_single_testimonial.py
- test_get_all_testimonials.py
- test_get_specific_testimonial.py
- test_testimonial_delete.py
- __init__.py
- test_topic.py
- __init__.py
- change_user_password_test.py
- test_delete_user.py
- test_get_all_users.py
- test_get_current_user_organizations.py
- test_get_users_by_role.py
- test_getuser.py
- test_superadmin_create_user.py
- test_updateuser.py
- test_user_model_indexing.py
- user_deactivation_test.py
- __init__.py
- conftest.py
- test_add_user_waitlist.py
- test_remove_user_from_waitlist.py
- test_retrieve_waitlist.py
- waitlist_email_test.py
- test_add_wishlist.py
- __init__.py
- test_google_oauth.py
- test_login_notification.py
- __init__.py
- conftest.py
- database.py
- run_all_test.py
- .dockerignore
- .env.sample
- .gitignore
- __init__.py
- alembic.ini
- docker-compose.prod.yml
- docker-compose.staging.yml
- docker-compose.yml
- Dockerfile
- LICENSE
- main.py
- README.md
- requirements.txt
- SECURITY.md
- seed.py
- setup.py
- test_case1.py
- update_api_status.py
# Installation Guide
1. Get the code
git clone https://github.com/hngprojects/hng_boilerplate_python_fastapi_web
Downloads the entire project code from GitHub to your computer.
cd hng_boilerplate_python_fastapi_web
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install pytest
Installs the package published on PyPI directly β no need to clone the source.
pip install pytest-cov
Installs the package published on PyPI directly β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.prod.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Python
EasyPrerequisites
python3 -m venv .venv
Runs the Python script (or module).
pip install -r requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
pip install pytest
Installs the package published on PyPI directly β no need to clone the source.
pip install pytest-cov
Installs the package published on PyPI directly β no need to clone the source.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)