Code Monkey home page Code Monkey logo

dlst-studio's Introduction

dlst-studio Build Status Dependencies

Jekyll site for the Digital Humanities @Columbia

Basic Information:

Features:

  • Active updates
  • Relational data
  • Student/Faculty/Librarian contributions
  • Custom search
  • IIIF (remote or local, if remote describe path)
  • Maps
  • D3
  • Other: ______

Dependencies

JS (i.e. runtime)

  • jquery

Ruby (i.e. dev/test)

  • jekyll
  • htmlproofer
  • rake

Branches

master: The up-to-date production branch (Jekyll/back-end).

  • Travis pushes compiled site to static branch after tests pass.
  • If using s3, Travis deploys compiled site to s3 prod bucket after tests pass.

staging : The staging branch (Jekyll/back-end)

  • Travis pushes compiled site (rebuilt with repo name as baseurl) to gh-pages branch after tests pass.
  • If using s3, Travis deploys compiled site (without baseurl) to s3 staging branch after tests pass.

static : The up-to-date compiled production site (static HTML)

  • Built and pushed by Travis on successful commit to master branch.

gh-pages : A copy of the compiled staging site hosted + viewable via GitHub pages (static HTML)

  • Built and pushed by Travis on successful commit to staging branch (viewable at cul.github.io/REPO-NAME/)

Contributing

  1. Clone the repository: $ git clone https://github.com/REPO-NAME
  2. Install dependencies: $ cd REPO-NAME && bundle
  3. Checkout your own branch: $ git checkout -b MY-FEATURE
  4. Make your changes
  5. Run tests locally: $ bundle exec rake wax:test
  6. Push branch to remote repository.
  7. Sumbit a PR to merge your branch into staging.
  8. If tests pass, confirm merge into staging and delete your branch. This will trigger a deployment of the compiled site from staging to the gh-pages branch (and if you're using s3, to the staging bucket).
  9. Preview the staged site (either at cul.github.io/REPO-NAME or the staging s3 bucket). If it looks good, submit a PR to merge staging into master.
  10. If the tests from the PR pass, an admin will accept the merge, and Travis will deploy a backup/copy of the compiled site to the static branch (and if you're using s3, it will deploy to the prod s3 bucket as well).

[link to full wiki].

Travis deployment set-up

[TO DO] Give basic steps and link to full wiki.

dlst-studio's People

Contributors

elotroalex avatar ktakahata avatar mnyrop avatar muziejus 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.