Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 3.34 KB

README.md

File metadata and controls

87 lines (61 loc) · 3.34 KB
Raw

SkyTest - Dynamic Data Collection Platform

SkyTest is an innovative, web-based platform designed to facilitate the dynamic documentation and analysis of test logs across various projects. It stands out by allowing users to customize data collection forms via a simple JSON configuration, making it versatile for a wide range of projects.

Key Features

  • Bootstrap Full Responsiveness: Ensures that the application is mobile-friendly and provides a seamless user experience across various devices and screen sizes.
  • Import/Export Functionality: Offers capabilities to import and export test data along with attachments and form definitions, allowing for easy data backup and restoration.
  • Multiple File Upload: Enhances data entry by allowing multiple files to be uploaded as part of test documentation, supporting images, videos, and log files. It is crucial to maintain the "attachments" field name in the tests structure JSON for the application to function correctly.

Getting Started

Follow these instructions to set up SkyTest in your local environment.

Prerequisites

  • Python 3
  • Flask

Ensure Python and Flask are installed on your system. SkyTest utilizes Flask, a lightweight WSGI web application framework, to serve web content.

Environment Setup

  1. Clone the repository:

    git clone https://github.com/alireza787b/SkyTest.git
cd SkyTest

  2. Create and activate a virtual environment:

    python3 -m venv venv
source venv/bin/activate

  3. Install dependencies:

    pip install -r requirements.txt

  4. Initialize the database: Note: This step is only required the first time you set up the project or whenever you make changes to the JSON configuration for the form fields.

    python initialize_db.py

  5. Run the application:

    python run.py

    The application will be available at http://localhost:5562 (or whatever port is defined in the config.py).

Running with Docker

For those preferring Docker, SkyTest can be easily deployed using Docker containers.

  1. Pull the Docker image:

    docker pull alireza787b/skytest:latest

  2. Run the Docker container: Replace <host_port> with your desired host port to access the application:

    docker run -d --restart=always -p <host_port>:5562 alireza787b/skytest:latest

    For example, to run on port 8080:

    docker run -d --restart=always -p 8080:5562 alireza787b/skytest:latest

    Access the application at http://<host_IP>:<host_port> eg. http://localhost:8080.

For the source code, additional resources, and a demo, visit our GitHub: alireza787b/SkyTest.

Configuration

SkyTest's form fields and structures are defined in JSON files within the definitions folder. It is essential to maintain the "attachments" field name in the tests structure JSON for the application to operate normally. Other settings can be customized through the config.py.

Contributing

SkyTest is open to contributions. Whether it's adding new features, enhancing existing ones, or improving the UI/UX, your contributions are welcome.

License

SkyTest is licensed under the GNU General Public License v3.0. See the LICENSE file for more details.