https://github.com/openpeeps/madam
Madam 💋 A lightweight local web server for Design Prototyping 🎨 and Front-end Development 🌈 WIP
https://github.com/openpeeps/madam
cli-server designer dev-server development-environment development-tools front-end front-end-development hacktoberfest madam-server nim-lang webserver
Last synced: 3 months ago
JSON representation
Madam 💋 A lightweight local web server for Design Prototyping 🎨 and Front-end Development 🌈 WIP
- Host: GitHub
- URL: https://github.com/openpeeps/madam
- Owner: openpeeps
- License: mit
- Created: 2022-02-01T08:40:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-03T20:27:43.000Z (over 2 years ago)
- Last Synced: 2025-05-07T19:47:27.186Z (5 months ago)
- Topics: cli-server, designer, dev-server, development-environment, development-tools, front-end, front-end-development, hacktoberfest, madam-server, nim-lang, webserver
- Language: Nim
- Homepage:
- Size: 1.09 MB
- Stars: 27
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Madam 💋 A lightweight local web server for Design Prototyping • Front-end Development 🌈
Pew pew pew! ZWIFF! Boom!
👋 Madam Welcome Screen is sooo POP! 🙀
## 😍 Key Features
- [x] Compiled, Fast, Low memory foot-print 🍃
- [x] < 1MB file size binary app
- [x] < 3MB RAM usage in Welcome Screen 🥳
- [x] Install once, run anytime, as many servers you need 👌
- [x] No code required
- [x] Serve Static Assets 📦
- [x] Configuration via `madam.yml`
- [ ] Static HTML Website Generator
- [x] Routes Management via `madam.routes.yml`
- [ ] Supports all HTTP verbs, `GET`, `POST`, `HEAD`, etc.
- [ ] Madam Skins / [Template Engine via Tim](https://github.com/openpeeps/tim) for `layout`, `view`, `partials`
- [x] Made for **Design Prototyping** and **Front-end Development**
- [x] Works on **Linux** and **OS X**
- [x] Open Source under `MIT` license
- [x] Pew pew pew! ZWIFF! 💋
## Why ?
Because NodeJS environment sucks and there are no other lightweight / easy to setup alternatives.
## 🥳 Best for
Prototyping. Showcase. JavaScript, HTML, CSS projects, libraries or packages. Also best for testers and designers. Pew pew again!
## 💅 Installing
Madam is currently available for **OS X** and **Linux distributions** only. You can compile Madam by yourself, or get the latest version from [GitHub releases](https://github.com/openpeeps/madam/releases).
Setup Madam to your `PATH` and do the do 🤓 Better said, do the blue! 😎
```zsh
ln -s ~/path/to/your/madam /usr/local/bin
```
## ✨ Madam Commands
```zsh
Madam 💋 A Lightweight & Fast Local Web Server for
Design Prototyping 🎨 and Front-end Development 🌈
👉 Info, updates and bugs: https://github.com/openpeeps/madam
Usage:
init Create a new Madam configuration file from CLI
run [--verbose] Run local server. Use verbose flag for tracking requests
build Build current project to Static HTML Website
Options:
-h --help Show this screen.
-v --version Show Madam version.
```
## Developing with Madam
Run `madam init` in your project directory and setup your `madam.yml` via command line wizard.
Here you can find a beautiful `madam.yml` configuration that covers all Madam features.
```yaml
name: "Awesome Madam"
path: "./example" # path to your root HTML project
port: 1230 # optional | default 1010
# Paths for layouts, views or partials
# These paths are prepended with project path provided above
# For example, layouts will point to "./example/layouts"
templates:
layouts: "layouts" # directory path for layouts
views: "views" # directory path for views
partials: "partials" # directory path for partials
routes:
get:
about: "about.html"
products/my-product: "product.html"
publish: "publish.html"
# Define your custom Middlewares
middlewares:
auth: "@login.session" # a fake auth middleware
# Setup Static Assets to serve any kind of static files via Madam
assets:
source: "./dist/assets/*" # Path on disk for indexing the static assets
public: "/assets" # Public route for accessing the static assets
# Customize console output
console:
logger: true # Enable http request logger
clear: true # Clear previous console output on request
```
## Madam Skins
The way you can stay **DRY**. Madam brings `layouts`, `views` and `partials` logic to your project.
On hold, Madam depends on 👉 [Tim Template Engine](https://github.com/openpeeps/tim) (WIP)
### Create the first page
_todo_
## Roadmap
#### 0.1.0
- [x] Create logo
- [x] Embedding Httpbeast
- [x] Routes Handler
- [x] Static Assets Handler
- [x] `init` command
- [x] `run` command with `--verbose` flag
- [ ] `build` command
- [ ] Multi-threading while generating project to Static HTML
- [ ] Templating via [Tim Engine](https://github.com/openpeeps/tim) supporting `layouts`, `views`, `partials`
- [ ] GitHub Workflow Action for [Cross Compilation and Release](https://github.com/nim-lang/Nim/wiki/BuildServices#8-cross-compilation-and-release)
- [ ] Talk about it on ycombinator / stackoverflow / producthunt
#### 0.2.0
- [ ] Fake content generator based on [Faker Nim library](https://github.com/jiro4989/faker)
### 0.3.0
- [ ] Madam GUI
### 🎩 License
Madam | `MIT` license. [Made by Humans from OpenPeeps](https://github.com/openpeeps).
Copyright © 2023 OpenPeeps & Contributors — All rights reserved.