KafuiAdaku/FeedbackForm

FEEDBACK FORM

The Feedback Form project is an online platform that enables clients to provide valuable suggestions and reviews, fostering an interactive and user-driven improvement process. Built with Flask, MySQL, Celery, and Redis, all components are containerized in Docker, ensuring seamless communication between them.

Table of Contents

• Project Overview
• Project Setup
  • Prerequisites
  • Setting Up Feedback Form
  • Environment Configuration
• Build and Run
• Testing
  • Running pytest
  • Test Coverage
• Initializing Database
• Test in Browser
• Contact
• License

Project Overview

The Feedback Form project serves as an online suggestion and review platform, allowing users to share their feedback and improve the overall user experience.

Project Setup

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed Docker and Docker Compose.
• You have a suitable text editor to edit .env and other files.

Setting Up Feedback Form

To install Feedback Form, follow these steps:

1. Clone the repository.
2. Set up your environment variables in the .env file:

Environment Configuration

Create a .env file in the project root and set the following values:

# Email Configuration
MAIL_USERNAME='yourgmail@email.com'
MAIL_PASSWORD='google app password'
MAIL_DEFAULT_SENDER='yourgmail@email.com'
ADMIN_EMAIL='random@email.com'

# Database Configuration
DATABASE_URL='mysql+pymysql://feedback:yourpassword@mysql:3306/feedback_form'
MYSQL_ROOT_PASSWORD='yourpassword'
MYSQL_DATABASE='feedback_form'
MYSQL_USER='feedback'
MYSQL_PASSWORD='yourpassword'

These values will be used by the config/settings.py file

To build a container from a docker compose file

docker-compose up --build

Run a docker-compose after already building

docker-compose up

To stop a running docker-compose app

docker-compose stop

TESTING THE APP AND COVERAGE

Running pytest directly inside the docker container

docker-compose exec website pytest feedback_form/tests

Testing the test coverage of our entire code to see if we missed some tests out

docker-compose exec website pytest --cov-report term-missing --cov feedback_form

INITIALIZING DATABASE

Before testing code, database has to be initialized with the commands below in a different terminal

docker-compose exec website env FLASK_APP=feedback_form/app.py flask db init
docker-compose exec website env FLASK_APP=feedback_form/app.py flask db migrate
docker-compose exec website env FLASK_APP=feedback_form/app.py flask db upgrade

TEST IN BROWSER

Visit localhost:8000 or 0.0.0.0:8000 in your web browser to test the application.

Contact

Authors

• Theophilus Ackom
• Dennis Adaku

License

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