Particularly simple old school single page lightweight web framework for clever javascript developers.
You need to be clever to understand why this framework is that party(cular) you want to have.
But I allow you to use it anyway!
- under heavy development, alpha state. First beta version including some documentation is planned to be released within spring 2021
TALBE OF CONTENTS
I just want to develop with Vanilla JS and HTML the old way, I want to directly run and debug the code I code in the browser.
I don't want to learn a new framework world. I can JavaScript, I want to do JavaScript. I want it simple, I want it stupid easy.
... and at the end I want to be happy! :-)
- Solid basic project structure
- Simple but powerful page pattern with loader / router
- Live development web server for JavaScript and SCSS
- Life cycle with hook feature
- Internationalization out of the box
- EJS template engine
- Builder to create compressed and minified .js and .css for production
CurlyBracketParser
for url parsingLuckyCase
for name case transformationsEJS
for embedded javascript template renderingjQuery
for having fun easily the old way
NodeJS and Yarn 1.x are installed. You may use npm instead of yarn.
yarn add global sipa
You have to ensure, that the path of yarns bin directory is added to PATH.
So if the command sipa
is not available after installation, add the following line to your shell config (~/.bashrc
, ~/.zshrc
/...):
export PATH="$(yarn global bin):$PATH"
npm install -g sipa
Depending on your global npm directory, you may need to run this command with sudo or as root:
sudo npm install -g sipa
That's it!
The command sipa
and its shortcut sipa
is now available on the command line.
Run sipa help
for more information.
Or get started with our tutorial here (TODO).
On the commandline run
sipa new
to get an interactive setup and answer the questions.
Check out the doc at ... to be done. ;-)
Either checking for mark down solution or even a github page. Github page may be generated from mark down sources.
Check for nice documentation templates
Check the need and technical options for translations (=> create the doc with the framework itself?)
- generators
- app release builder
- automatic index.html source manager
- index.html src update before build and before live development server start
- file watcher to automatically trigger index.html src update for live development server
- developer documentation (github page?)
- sipa updater (
update
task) - built-in ejs rendering for pages and layouts
- built-in translation service
- test on windows platform
- test on naked linux platform (VM)
- add unit tests
Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/sipa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.