dithn/servermonitor

ServerMonitor is a web application for monitoring websites.

ServerMonitor

ServerMonitor is a web application for monitoring the status of web pages based on their response. It also gives you additional information about the website like IP adress, ping and the location of the web server.

What's the intention of this repository?

Mostly, the goal is to learn (more or less) everything about web development. Starting from getting an idea what to build, over planning what to do next up to coding the actual application. Also getting into working with others on such a project is something, I want to accomplish with this project.

Can I already contribute?

Simple answer - Yes! Unfortunately, there are currently no contribution guidelines for this project and therefore there is no "correct way" to contribute. If you have an suggestion for something that could be improved, simply do a PR (Pull Request).

I'm happy about anyone who wants to help. 💪

How to setup?

Step 1: Clone the repository

git clone https://github.com/ChristianLutzCL/ServerMonitor.git
cd ServerMonitor

Step 2: Create a VirtualEnvironment with the name 'venv'

Note: Naming your VirtualEnvironment this way helps, if you use VSCode.

python -m venv venv

Step 3: Activate your VirtualEnvironment

-> Windows Powershell

venv/Scripts/activate

Step 4: Install the requirements

(venv) pip install -r requirements.txt

Step 5: Generate new database

(venv) python create_database.py

Step 6: Run the application

(venv) python run.py

*(venv) -> VirtualEnvironment is activated

- Note:

To get the app running, open config.py and create a EnvironmentVariable for Flask and the IPSTACK-API on your local machine. ServerMonitor uses the IPSTACK-API for certain operations. Please visit https://ipstack.com and create your own API-Key.

Using VSCode

If you're using VSCode for development, it helps if you name your VirtualEnvironment 'venv'. The reason is, this repository contains a .vscode folder in it with a predefined launch.json file.

To run ServerMonitor via VSCode, simply start the debugger and choose "Flask [DEVELOPMENT]" as launch configuration.

        {
            "name": "Flask [DEVELOPMENT]",
            "type": "python",
            "request": "launch",
            "stopOnEntry": false,
            "module": "flask",
            "cwd": "${workspaceRoot}",
            "env": {
                "FLASK_APP": "run.py",
                "FLASK_ENV": "development",
                "APP_SETTINGS": "config.cfg",
                "FLASK_DEBUG": 1
            },
            "args": [
                "run",
                "-p",
                "8080"
            ],
            "envFile": "${workspaceRoot}/venv",
            "debugOptions": [
                "WaitOnAbnormalExit",
                "WaitOnNormalExit",
                "RedirectOutput"
            ]
        },

License

GNU General Public License (GPL v3.0) - Christian Lutz. Please have a look at the LICENSE for more details.