https://github.com/sveetch/sveetch.github.io
My homepage on Github
https://github.com/sveetch/sveetch.github.io
optimus
Last synced: 5 months ago
JSON representation
My homepage on Github
- Host: GitHub
- URL: https://github.com/sveetch/sveetch.github.io
- Owner: sveetch
- Created: 2024-08-23T15:32:19.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-28T01:33:07.000Z (over 1 year ago)
- Last Synced: 2025-02-28T09:39:24.734Z (over 1 year ago)
- Topics: optimus
- Language: HTML
- Homepage: https://sveetch.github.io/
- Size: 226 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
Awesome Lists containing this project
README
.. _Optimus: https://optimus.readthedocs.io/
.. _Python: https://www.python.org
.. _virtualenv: https://virtualenv.pypa.io
.. _pip: https://pip.pypa.io
.. _Node.js: https://nodejs.org
.. _Bootstrap frontend toolkit: https://getbootstrap.com/
===================
Sveetch Github home
===================
`My homepage on Github `_ to promote some things.
Developed with `Optimus`_ and `Bootstrap frontend toolkit`_.
Prerequisites
*************
* `Python`_>=3.8;
* `virtualenv`_;
* `pip`_;
* `Node.js`_>=18;
* GNU make (or any Makefile tool compatible);
Install
*******
Once prerequisites are filled, you just have to clone repository and run this
command line: ::
make install
Usage
*****
Once installed you can build everything: ::
make frontend mo html
This will build the development version in directory in ``dist/dev/``.
Finally you can then serve the static build: ::
make server
Or push it anywhere on a web server since it is only a static site.
Going further
*************
See the Makefile help for details about available helpful tasks: ::
make help
And see the `Optimus`_ documentation for more details on how to work on this project.
Deployment
**********
Deployment is done with `Github pages `_ system.
Workflow
--------
* We are developing into master branch;
* Once a release is finalized, we bump version from ``cookiebaked.json``;
* Add a release into changelog file;
* Commit and push to master;
* Switch into branch ``github-pages``;
* Rebase the branch with master;
* Build into production mode;
* Push ``github-pages``;
* The GitHub Actions workflow will this branch update and will deploy site;