Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 3.07 KB

README.md

File metadata and controls

51 lines (38 loc) · 3.07 KB
Raw

Build status Github license Github stars Github forks GitHub issues GitHub code size in bytes GitHub contributors Codiga code quality

Live demo

Buildy

Please take a look at the scalable standalone versione based on the MERN stack --> standalone-branch

Buildy is a continuous deployment platform that is hosted on GitHub pages. It is a simple, easy to use, and powerful tool for building and deploying your Java projects.

Table of contents

  1. Workflow
  2. Installation instructions
  3. Standalone version

Workflow

The workflow is easy to understand, and it is based on GitHub Actions:

  1. Every 10 minutes an action is triggered which runs the NodeJS component of Buildy;
  2. The NodeJS component is responsible for building the project and deploying it to GitHub pages. For doing so it needs to:
    1. Check every tracked project1 to see if there are new commits;
    2. If there are new commits, it will clone the project and then build it;
    3. A html page for the project is generated using Handlebars, as well as a log file and an SVG badge for the build outcome;
    4. The build artifacts, the log file and the html page are committed and pushed to the Buildy repository;
    5. A GitHub action will then update GitHub pages.

How to install

You can easily install a copy of Buildy by forking the master branch of this repository.
After forking the repo you will need to modify the .github/workflows/node.js.yml action by modifying the ENV variable REPO_URL to your fork url.
Lastly you will need to create a secret called MYTOKEN which will contain a GitHub personal access token that Buildy will use to push commits on the fork.

Standalone version (MERN stack)

You can find a standalone version of Buildy that uses the MERN stack (MongoDB, Express, React and NodeJS) in the standalone-version branch.
You will find the instructions for installing that version in the README.md file.

Footnotes

  1. All the tracked projects are listed in the projects.json file. ↩