Giter Club home page Giter Club logo

sorg's Introduction

sorg Build Status

A Go-based build script that compiles my personal website. This is the site's second incarnation, with the original being a Ruby/Sintra stack (sorg = "static org").

The site deploys automatically from its CI build with GitHub Actions as changes are committed to the master branch.

Clone

git clone https://github.com/brandur/sorg.git

Build

Install Go 1.9+ and direnv, then:

cp .envrc.sample .envrc

direnv allow

# Compile Go executables.
make install

# Run an initial build of the site, look for build output in public/.
make build

# Watch for changes in Go files and/or content and recompile and rebuild when
# one occurs.
make loop

The project can be deployed to s3 using:

pip install awscli

export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
export S3_BUCKET=...
make deploy

Cached photos can be fetched using:

make photographs-download

Development

Run the entire lifecycle like in CI:

make

Run the test suite:

make test

Run a single package's test suite or single test:

go test ./markdown
go test ./markdown -run TestCollapseHTML

Get more verbose output while running tests:

go test -v ./markdown

sorg's People

Contributors

brandur avatar rwz avatar adsouza avatar shubham391 avatar spencercdixon avatar dependabot[bot] avatar andyatkinson avatar bgentry avatar cmwright avatar juanitofatas avatar maxdeviant avatar mattymc avatar rafbm avatar russelldavis avatar charettes avatar smizell avatar v-kolesnikov avatar ferhatelmas avatar jorinvo avatar 1dollarsteak avatar ameech avatar asimpson avatar alexcameron89 avatar rattrayalex avatar ololobus avatar alexitc avatar amitlan avatar whysthatso avatar arpitbatra123 avatar bjeanes avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.