Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamonholmgren/qub
Qub is a CLI and QB64 web framework for building websites with QBasic. Star this repo!
https://github.com/jamonholmgren/qub
cli framework qb64 qbasic web
Last synced: about 1 month ago
JSON representation
Qub is a CLI and QB64 web framework for building websites with QBasic. Star this repo!
- Host: GitHub
- URL: https://github.com/jamonholmgren/qub
- Owner: jamonholmgren
- License: other
- Created: 2023-11-29T02:27:44.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-05T05:57:52.000Z (about 2 months ago)
- Last Synced: 2024-08-06T06:50:51.590Z (about 2 months ago)
- Topics: cli, framework, qb64, qbasic, web
- Language: Visual Basic 6.0
- Homepage: https://qub.jamon.dev
- Size: 2.19 MB
- Stars: 84
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Qub -- QBasic Website Generator
Qub (pronounced "cube") is a CLI that generates a web server and framework for building websites in [QB64](https://qb64.com/) -- a more modern variant of QBasic.
## Getting started
_(Note: macOS & Linux only)_
To get started, set up your `qub` alias first. This is the quick & easy way:
```
alias qub="source <(curl -sSL https://raw.githubusercontent.com/jamonholmgren/qub/main/src/cli.sh)"
```
However, some are understandably uncomfortable with running a script directly from the internet. If you'd like to run it locally, here's how:
Manual setup
Download it:
```
curl -sSL https://raw.githubusercontent.com/jamonholmgren/qub/main/src/cli.sh > ./qub.sh
```
Open the `qub.sh` file in your editor and review it. If you're comfortable with what it's doing, alias it:
```
alias qub="source $PWD/qub.sh"
```
Now, you should be able to run the CLI:
```
qub
qub --version
qub --help
qub create
qub update
```
_**Windows Support:** Qub has only been tested on macOS and Linux. It might work on Windows WSL (Windows Subsystem for Linux) or Git Bash on Windows. If you want to help test and make it run on Windows, please open an issue or PR!_
## Creating a website
To create a website, run `qub create` and follow the prompts:
```
qub create
```
It'll ask you for your domain name (e.g. jamon.dev) which doubles as your project's folder name. It will also ask if you want to install QB64 (I recommend you do).
When done, you can CD into the new folder and run `./bin/build` to build the website. Then, run `./server` to start the web server. Visit [http://localhost:6464/](http://localhost:6464/) to view the website.
## Modifying your website
Your new website has the following folder structure:
```
bin
qub
server.bas
qub.conf
web
pages
home.html
contact.html
static
scripts.js
styles.css
layout.html
README.md
```
### qub/server.bas
This is the Qub web server. You can periodically update it by running `qub update`. Note this will blow away any modifications you've made, so be careful!
Qub's web server was originally based on [Yacy](https://github.com/smokingwheels/Yacy_front_end) by SmokingWheels, but has been heavily modified since. It comes with a number of features:
- [x] Page routing (e.g. jamon.dev/links renders web/pages/links.html)
- [x] Individual header and footer and support
- [x] Static file serving (css, js, etc)
- [x] Binary file serving (images, fonts, etc)
- [x] Custom 404 page support
- [x] Basic dynamic variable support (e.g. `` in web/layout.html, etc)
- [x] Custom port support (via ./qub.conf)
- [ ] Customizable dynamic variable support (coming soon)
- [ ] 301 redirects support (coming soon)
- [ ] Custom 500 page support (coming soon)
- [ ] More customizable templating support (coming soon)
It does not (and probably won't) support HTTPS or HTTP2. I recommend putting CloudFlare in front of it in production (more in the [deploy guide](#deploy-guide) below).
### Common included files
In the `web` folder, you'll find a layout.html file.
This is the standard layout for your website, and includes your html's head and body sections,
with placeholder comments for dynamic content like what page is being rendered.
```html
```
### web/pages
This is where your website's pages go. Each page is an HTML file. You can add as many as you want, and they'll be routed automatically (minus the .html extension).
So, for example, if you add `web/pages/links.html`, it will be available at `example.com/links`. If you add a folder it'll route to that as well, so `web/pages/blog/2023.html` will be available at `example.com/blog/2023`.
### web/static
You'll put your static files here -- CSS, JS, images, fonts, etc. They'll be served at `example.com/static/` (e.g. `example.com/static/styles.css`). Any image files, fonts, PDFs, etc will be served as binary files (e.g. `example.com/static/logo.png`).
### 404.html
If you want to customize your 404 page, you can do so by editing `web/pages/404.html`. This is shown if the router is unable to find a page for the given URL. It'll also respond with the proper 404 status code.
## Deploy Guide
COMING SOON!
## History
When I was twelve, I built my first game in QBasic -- and kept building games and small apps (we called them "programs" in those days) for years. I have a lot of nostalgia and a special place in my heart for QBasic.
A few years ago, I was talking about rebuilding my website in something different, just for a fun challenge, and my friend Mark Villacampa said ["do it in BASIC you coward!"](https://twitter.com/MarkVillacampa/status/1594426506754801664). I took on the challenge and built [jamon.dev](https://jamon.dev) in QB64.
Once I had a working website, I realized that I wanted to make it easier for other people to build websites in QB64, so I started building Qub, aided by [@knewter](https://github.com/knewter) who is another QBasic fan from way back.
Qub is not particularly important to modern technology in the grand scheme of things, but it's been a blast to work on. I hope you enjoy it!
## Future
I'd love to build more QBasic-powered server capabilities. I'm still learning how to utilize QB64 -- for example, in old QBasic, you couldn't include external files, but in QB64 you can.
## TODO
- [ ] Make the default template look nicer, better template README
- [ ] YouTube video on Jamon's Code Quests
## License
MIT -- see [LICENSE](LICENSE) for details.
QB64 is licensed under the [MIT](https://github.com/QB64Official/qb64/blob/master/licenses/COPYING.TXT) license.