CloudWorx-Backend

Flask-Based Backend for CloudWorx project.

As part of a joint project called "CloudWorx", this repository is part of a three part series involving the work of three students. The other two repositories are:

• CloudWorx-Client led by @Elle0-0
• CloudWorx-Web led by @darragh0

Virtual Environment Setup

1. Create a virtual environment:

   python -m venv venv

2. Activate the virtual environment:

   • On Windows:

     .\venv\Scripts\activate

   • On macOS/Linux:

     source venv/bin/activate

3. Install the required packages:

   pip install -r requirements.txt

Running the Application Locally

1. Make a copy of the env.sample file and rename that copy to .env. Update the values in the .env file as needed.

2. Look through the .env file and make sure USE_LOCAL_CONFIG is set to 1 to use the local configuration.

3. Navigate to wsgi and run the application:

   python -m wsgi

4. The application will now be available at http://127.0.0.1:6174/ for HTTP API access

You can find the documentation for the API at http://127.0.0.1:5000/docs on the local config or alternatively at https://networkninjas.gobbler.info/docs