morten/mini-loader
1
0
Fork 0
mirror of https://github.com/morten-olsen/mini-loader.git synced 2026-02-08 01:36:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: completed v1 docs (#36)

Browse Source
This commit is contained in:
Morten Olsen
2024-01-15 15:10:19 +01:00
committed by GitHub
parent 161a098c9f
commit 1c3b993ab2
27 changed files with 226 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -1,10 +1,8 @@
![banner](./assets/banner.png)
# Welcome to Mini Loader! 🌐
Welcome to mini loader, a lightweight, Docker-based server solution for managing and executing workloads with ease. Designed for developers, small teams, and anyone in need of a simple yet powerful tool for running tasks, hosting API servers, or scheduling routine jobs.
Welcome to mini loader, a lightweight server solution for managing and executing workloads with ease. Designed for developers, small teams, and anyone in need of a simple yet powerful tool for running tasks, hosting API servers, or scheduling routine jobs.
## Features
@@ -15,20 +13,37 @@ Welcome to mini loader, a lightweight, Docker-based server solution for managing
- **Task Scheduling**: Built-in support for cron-like job scheduling.
- **HTTP Gateway**: Expose a HTTP server from your workloads
Also see [anti-features and limitations](./docs/anti-features.md)
Also see [anti-features and limitations](./docs/02-anti-features.md)
:construction: This project is under active development and has not reached v1.0 yet. Expect some bugs and potential breaking changes in APIs. We appreciate your patience and welcome your feedback as we work towards a stable release!
For an overview of what's coming next, check out our roadmap at [GitHub Milestones](https://github.com/morten-olsen/mini-loader/milestones).
## Quick Start
Get up and running with mini loader in just a few steps:
1. **Install the CLI**: `npm install -g @morten-olsen/mini-loader-cli`
2. **Deploy the Server**: `docker run -p 4500:4500 —-name mini-loader ghcr.io/morten-olsen/mini-loader`.
3. **Get your access token**: `docker exec mini-loader mini-loader-server create-token`
4. **Login**: `mini-loader auth login http://localhost:4500`
5. **Push Your First Load**: `mini-loader loads push script.mjs -r -i first`
6. **See the logs**: `mini-loader logs ls -l first`
```bash
# Install the CLI and the server
npm i -g @morten-olsen/mini-loader-cli @morten-olsen/mini-loader-server
For a detailed guide on getting started, please refer to the [Getting Started Tutorial](./docs/getting-started.md).
# Start the server
mini-loader-server start &
# Get your access token
mini-loader-server create-token
# Authenticate the CLI
mini-loader auth login
# Push your first workload
mini-loader loads push -r -ai my-script.js -i first
# See the output logs
mini-loader logs ls -l first
```
For a detailed guide on getting started, please refer to the [Getting Started Tutorial](./docs/01-getting-started.md).
## Support and Contributions
@@ -43,4 +58,4 @@ mini loader is open-source software licensed under the [GPL-3 License](./LICENSE
## Let's Get Started!
Dive into the world of simplified workload management with mini loader. Start with our [Getting Started Tutorial](./docs/getting-started.md) and unleash the full potential of your tasks and applications!
Dive into the world of simplified workload management with mini loader. Start with our [Getting Started Tutorial](./docs/01-getting-started.md) and unleash the full potential of your tasks and applications!