Skip to content
Static website for Buildarium
HTML CSS Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images
styles
CNAME
Dockerfile
Dockerfile-dev
Jenkinsfile
README.md
about.html
docker-compose.yml
index.html

README.md

bdweb-static

Buildarium Static Splash Site

Version Docker Cloud

Slack Channel Email Maintenance

Screenshot


Table of Contents


Installation

Clone

  • Clone this repo to your local machine using git@github.com:buildarium/bdweb-app.git

Setup

Install Docker

Helpful Commands

From here, you probably want to check out a branch other than master:

View branches on the remote

$ git branch -v -a

Checkout a branch (will copy to local if only on remote)

$ git checkout [BRANCH]

Features

  • Hopefully SEO optimized
  • Provide single place for splash for Buildarium

Documentation

WIP

Tests

Running unit tests

WIP

Linting

WIP


Contributing

To get started...

Use the Git Flow branching model and SemVer for versioning.

Step 1

  • 👯 Clone this repo to your local machine

  • 🔎 Ensure sure you have a local copy of the develop branch

$ git branch -a
* master
  remotes/origin/HEAD
  remotes/origin/master
  remotes/origin/develop
  ...
$ git checkout develop
Branch develop set up to track remote branch experimental from origin.
Switched to a new branch 'develop'
$ git branch
* develop
  master
  • 🌱 Create a feature branch off the develop branch
$ git checkout -b myfeature develop
Switched to a new branch "myfeature"

Step 2

  • HACK AWAY! 🔨🔨🔨
  • 📦 Deployments are automatic to the Testing Ecosystem whenever a commit is pushed

Step 3

  • 🏷 Decide the proper version number as per SemVer and edit package.json
    • Given a version number MAJOR.MINOR.PATCH, increment the:
      • MAJOR version when you make incompatible API changes
      • MINOR version when you add functionality in a backwards-compatible manner, and
      • PATCH version when you make backwards-compatible bug fixes.

package.json:

{
  ...
  "version": "MAJOR.MINOR.PATCH",
  ...
}
  • 👨‍🍳 Prepare the develop branch to be merged into and ensure it's up-to-date
$ git checkout develop
Switched to branch 'develop'
$ git pull
  • 🔀 Merge your feature branch into develop
$ git merge --no-ff myfeature
Updating ea1b82a..05e9557
(Summary of changes)
$ git branch -d myfeature
Deleted branch myfeature (was 05e9557).
$ git push origin develop

The --no-ff flag causes the merge to always create a new commit object, even if the merge could be performed with a fast-forward. This avoids losing information about the historical existence of a feature branch and groups together all commits that together added the feature

Deployment

Development Ecosystem

When developing locally, simply use:

$ docker-compose up

This will start build all necessary Docker images and start up any Docker container(s) necessary to run.

Additionally, docker-compose.yml will automatically expose local ports for testing, and will mount the local code into the Docker container for hot reloads.

All you need to do is write code and test (hot reloading is enabled). You can view the running container at http://localhost:5200.

Testing Ecosystem

Commits submitted to the develop branch will automatically be built into a Docker image and pushed to the Docker container registry.

From there, we have a Digital Ocean droplet running Watchtower, which will automatically pull new images from the Docker container registry and swap them out.

To ensure successful deployment to the Testing Ecosystem:

  • Ensure the Dockerfile still builds a usable image

You can view the running container at http://test.buildarium.com.

Staging Ecosystem

Deployment to Staging is triggered manually with containers built from the release-* branch.

To prepare for the Staging Ecosystem, it is a good idea to:

  • All unit, integration, and e2e tests are passing
  • Ensure new features are properly covered by appropriate tests
  • Provide proper documentation for new features in the official docs
  • Ensure new code abides by the style guide

Production Ecosystem

Deployment to Production is triggered manually from the container registered from the master branch upon proper QA testing and when the time is right.

Don't fuck up.


Team

Buck Tower Michael Wlodawsky
Buck Tower Michael Wlodawsky
github.com/bucktower github.com/wlodawskymichael

FAQ

  • How do I do specifically so and so placeholder?
    • No problem! Just do this.

Support

Reach out at one of the following places!


License

You can’t perform that action at this time.