https://github.com/cookiengineer/lycheejs-website

:globe_with_meridians: The lychee.js website (built with lychee.js, auto-fertilized and auto-published)
https://github.com/cookiengineer/lycheejs-website

lycheejs website

Last synced: 14 days ago
JSON representation

:globe_with_meridians: The lychee.js website (built with lychee.js, auto-fertilized and auto-published)

• Host: GitHub
• URL: https://github.com/cookiengineer/lycheejs-website
• Owner: cookiengineer
• Created: 2015-12-30T13:48:50.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-07T00:29:49.000Z (2 months ago)
• Last Synced: 2024-09-07T03:07:28.324Z (2 months ago)
• Topics: lycheejs, website
• Language: HTML
• Homepage: https://lychee.js.org
• Size: 5.58 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# lychee.js Website

## Overview

This website is a project made with [lychee.js](https://lychee.js.org).

It is automatically built and deployed to GitHub using the following

`lycheejs-fertilizer` integration scripts:

- `bin/build.sh` builds the website and copies asset and download folders

- `bin/package.sh` packs everything to the `gh-pages` branch

- `bin/publish.sh` pushes the `gh-pages` branch to github

## IMPORTANT: Structure

The `./build` folder is a `git repository` containing the `gh-pages` branch!

Be careful with your branches when something went wrong.

The `master` branch (which is NOT the default branch of the repository)

contains all assets and source files. The `build` folder is only temporarily

this same `git repository` with the `gh-pages` branch to deploy the website to

GitHub.

If you work on this project, always work on the `master` branch!

## Installation and Build Process

The build process is integrated with the `lycheejs-fertilizer` toolchain.

These are the steps to get everything to run and build properly:

Local development requires zero overhead, just start the `lycheejs-harvester`

and use the existing toolchain.

```bash

cd /opt/lycheejs;

# This will clone the website repository correctly

git clone --single-branch --branch master [email protected]:cookiengineer/lycheejs-website.git ./projects/lycheejs-website;

# This will build and deploy the website automatically

lycheejs-fertilizer html/main /projects/lycheejs-website;

```