License Mate

https://github.com/yjpictures/license-mate
Admin
Software License Manager: Docker deployable Flask REST API server with MongoDB database, simplifying...
Tokens:2,612
Snippets:20
Trust Score:6.1
License:GPL-3.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Development Dependencies

Source: https://github.com/yjpictures/license-mate/blob/master/server-ui/README.md

Installs all necessary Node.js packages for initial development setup. This command should be run once after cloning the repository from within the `/server-ui` directory.

```bash
npm i
```

--------------------------------

### Initialize Python Virtual Environment and Install Dependencies

Source: https://github.com/yjpictures/license-mate/blob/master/server/README.md

These commands create and activate a Poetry virtual environment, then install all required project dependencies for local development. This is typically a one-time setup process.

```PowerShell
poetry shell
poetry install
```

--------------------------------

### Install Production Dependencies and Run Gunicorn Server

Source: https://github.com/yjpictures/license-mate/blob/master/server/README.md

These commands are for deploying the application in a production environment. First, it installs only the dependencies marked for production. Then, Gunicorn is used to serve the Flask application, providing a robust and scalable web server.

```PowerShell
poetry install --with prod
gunicorn main:app
```

--------------------------------

### Build UI for Production

Source: https://github.com/yjpictures/license-mate/blob/master/server-ui/README.md

Installs production-only dependencies and then builds the ReactJS UI for deployment. This process generates a `server-ui.js` file in `/server/static/js`, which is then served by the Flask server. Ensure the `baseURL` in `src/Api.js` is set for production.

```bash
npm i --omit=dev
npm run build
```

--------------------------------

### Start React Development Server

Source: https://github.com/yjpictures/license-mate/blob/master/server-ui/README.md

Launches the Node.js development server for the ReactJS UI, enabling live reloading and immediate feedback on code changes. Ensure the `baseURL` in `src/Api.js` is configured for local Flask server access.

```bash
npm start
```

--------------------------------

### Run Flask Development Server

Source: https://github.com/yjpictures/license-mate/blob/master/server/README.md

This command starts the Flask application in debug mode, making it accessible on port 80. Ensure the Poetry virtual environment is active before executing this command for development purposes.

```PowerShell
flask --app main run --debug --port 80
```

--------------------------------

### Add New npm Package

Source: https://github.com/yjpictures/license-mate/blob/master/server-ui/README.md

Installs a new package and adds it to the project's `package.json` dependencies. Replace `<package>` with the desired package name to integrate new libraries or tools.

```bash
npm i <package>
```

--------------------------------

### Example .env Configuration File

Source: https://github.com/yjpictures/license-mate/blob/master/server/README.md

This sample .env file illustrates the environment variables used by the License-Mate server. It includes optional fields like MongoDB database name and license key length, connection strings for MongoDB, and passwords for different REST API user types (ADMIN, MANAGER, CLIENT). It also defines user-configurable fields for license creation and uniqueness validation.

```env
# =========================
# OPTIONAL FIELDS
# =========================
# This is for the name of MongoDB database
# default: production
SERVER_ENV=development
# -------------------------
# This is for the auto-generated license key length
# default: 32
LICENSE_LEN=16
# -------------------------
# This is the connection string for MongoDB database
# default: mongodb://database:27017/
MONGODB_URI=mongodb+srv://<username>:<password>@<yourcluster>.mongodb.net/
# -------------------------

# =========================
# PASSWORDS FOR REST APIs
# =========================
# This user type can create, validate, update, get-all, delete a license
ADMIN_PWD=<admin_password>
# -------------------------
# This user type can create, validate, update, delete a license
MANAGER_PWD=<manager_password>
# -------------------------
# This user type can validate a license
CLIENT_PWD=<client_password>
# -------------------------

# =========================
# USER CONFIGURABLE SECTION
# =========================
# These are the fields that will be created for each license
REQUIRED_CREATE=name, email, company, product, machine-node, machine-sn
# -------------------------
# These are the fields that are used to check if a new license is unique or not
# If ANY of these fields have duplicate values in database then a license will not be created
# These fields SHOULD be in the 'REQUIRED_CREATE' and should match the case
UNIQUE_VALIDATE=email, machine-node, machine-sn
# -------------------------
```

--------------------------------

### Add Python Packages with Poetry

Source: https://github.com/yjpictures/license-mate/blob/master/server/README.md

Use these commands to add new Python packages to your project. The first command adds a package generally, while the second specifically adds it to the 'prod' dependency group, useful for production-only requirements.

```PowerShell
poetry add <package>
poetry add <package> --group prod
```

--------------------------------

### Run License Mate with Docker Compose

Source: https://github.com/yjpictures/license-mate/blob/master/docker/README.md

This PowerShell command initiates the License Mate application using Docker Compose. It allows users to specify a Docker Compose file from a set of predefined configurations, enabling flexible deployment across local or cloud MongoDB environments and different development setups like `dev-mount.yml` or `dev-static.yml`.

```PowerShell
docker compose -f .\docker\<local/cloud>-MongoDB\<your-choice>.yml up
```

--------------------------------

### Run Development Static Docker Container

Source: https://github.com/yjpictures/license-mate/blob/master/docker/builds/README.md

Command to run the 'flask-dev-static' Docker image in a container. It maps port 80 from the host to the container and loads environment variables from a specified file. This setup is for development testing with pre-copied application files.

```PowerShell
docker run -p 80:80 --env-file <env-file-path> flask-dev-static
```

--------------------------------

### Remove npm Package

Source: https://github.com/yjpictures/license-mate/blob/master/server-ui/README.md

Uninstalls a package from the project and removes its entry from `package.json`. This command helps in cleaning up unused dependencies.

```bash
npm uninstall <package>
```

--------------------------------

### Remove Python Packages with Poetry

Source: https://github.com/yjpictures/license-mate/blob/master/server/README.md

This command removes a specified Python package from your project's dependencies managed by Poetry. It updates the project's dependency lock file accordingly.

```PowerShell
poetry remove <package>
```

--------------------------------

### Initialize Swagger UI for API Documentation

Source: https://github.com/yjpictures/license-mate/blob/master/server/templates/docs.html

This JavaScript snippet initializes the Swagger UI bundle upon window load. It configures the UI to fetch API definitions from 'docs.yaml', sets the target DOM element, enables deep linking, and applies standard presets and plugins for a standalone layout.

```javascript
window.onload = function() { // Begin Swagger UI call region
  const ui = SwaggerUIBundle({
    url: "{{ url_for('static', filename='docs.yaml') }}",
    dom_id: '#swagger-ui',
    deepLinking: true,
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ],
    plugins: [
      SwaggerUIBundle.plugins.DownloadUrl
    ],
    layout: "StandaloneLayout"
  })
  // End Swagger UI call region
  window.ui = ui
}
```

--------------------------------

### Run Development Dynamic Docker Container with Volume Mounts

Source: https://github.com/yjpictures/license-mate/blob/master/docker/builds/README.md

Command to run the 'flask-dev-mount' Docker image in a container. It maps port 80 and mounts several local directories and files (static, templates, main.py, database.py, .env) into the container. This enables live development by reflecting local file changes instantly.

```PowerShell
docker run -p 80:80 -v $pwd\server\static:/server/static -v $pwd\server\templates:/server/templates -v $pwd\server\main.py:/server/main.py -v $pwd\server\database.py:/server/database.py -v $pwd\server\.env:/server/.env flask-dev-mount
```

--------------------------------

### Run Production Docker Container

Source: https://github.com/yjpictures/license-mate/blob/master/docker/builds/README.md

Command to run the 'gunicorn-prod' Docker image in a container for production deployment. It maps port 80 from the host to the container and loads environment variables from a specified file, suitable for a production environment.

```PowerShell
docker run -p 80:80 --env-file <env-file-path> gunicorn-prod
```

--------------------------------

### Build Production Docker Image

Source: https://github.com/yjpictures/license-mate/blob/master/docker/builds/README.md

Command to build the 'gunicorn-prod' Docker image for final production deployment. This image is configured to use 'gunicorn' for serving the application. It uses the 'prod.Dockerfile' and bypasses the build cache.

```PowerShell
docker build  . -t gunicorn-prod --no-cache -f .\docker\builds\prod.Dockerfile
```

--------------------------------

### Build Development Static Docker Image

Source: https://github.com/yjpictures/license-mate/blob/master/docker/builds/README.md

Command to build the 'flask-dev-static' Docker image for development. This image is designed for testing where application files are already copied into the image. It uses the 'dev-static.Dockerfile' and bypasses the build cache.

```PowerShell
docker build  . -t flask-dev-static --no-cache -f .\docker\builds\dev-static.Dockerfile
```

--------------------------------

### Basic HTML and Body CSS Styling

Source: https://github.com/yjpictures/license-mate/blob/master/server/templates/docs.html

Applies fundamental CSS rules to the HTML and body elements, including box-sizing for consistent layout, overflow properties for scrollbars, and basic margin and background color settings.

```css
html { box-sizing: border-box; overflow: -moz-scrollbars-vertical; overflow-y: scroll; }
*, *:before, *:after { box-sizing: inherit; }
body { margin:0; background: #fafafa; }
```

--------------------------------

### Build Development Dynamic Docker Image

Source: https://github.com/yjpictures/license-mate/blob/master/docker/builds/README.md

Command to build the 'flask-dev-mount' Docker image for development. This image is intended for testing where local files are mounted into the container, allowing for live reloads on file changes. It uses the 'dev-mount.Dockerfile' and bypasses the build cache.

```PowerShell
docker build  . -t flask-dev-mount --no-cache -f .\docker\builds\dev-mount.Dockerfile
```
Tokens:
Raw