Home Explore Help
Sign In
biheng
/
uppy
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: d418dba372
Branches Tags
uppy
/
README.md

README.md 2.9 KB
History Raw

uppy

A work in progress - nothing to see here.

Interesting places if you want to dig in:

Uppy Development

First clone and install the project:

git clone git@github.com:transloadit/uppy.git
cd uppy
npm install

Our website's examples section is also our playground. To get it to run locally type:

make website-preview

Website Development

We keep the uppyjs.io website in ./website for so it's easy to keep docs & code in sync as we're still iterating at high velocity. For those reading this screaming murder, HashiCorp does this for all their projects, and it's working well for them on a scale vastly more impressive than :dog:'s.

The site is built with Hexo, and Travis automatically deploys this onto GitHub Pages (it overwrites the gh-pages branch at every deploy).

Content is written in Markdown and located in ./website/src. Feel free to fork & hack!

./website/update.js is called during website builds to inject the Uppy versions & filesizes into the documentation. website in an independent folder (with e.g. its own package.json) and so it cannot rely on anything from the root project directly. update.js is the bridge that explicitly makes information available by injecting it into the website.

It's recommended to exclude ./website/public/ from your editor if you want efficient searches.

For local previews on http://127.0.0.1:4000 type:

make website-preview

FAQ

Why does your site look like vuejs.org?

The website is currently a clone of Yuxi Evan You's wonderful Vue.js website (view license) - just so we can hit the ground running in terms of Haxo boilerplate, etc. Obviously as soon as possible, we'll start rolling out our own layout & content and make this place our own. We'll keep the Vue website MIT license & credit in the footer in tact of course.

What does Travis do?

Travis should:

  • check out code
  • build project
  • run unit tests
  • run acceptance tests
  • copy/install the built project into any examples/*/
  • deploy the examples to our hackathon S3 bucket in a folder named by branch (http://hackathon.transloadit.com/uppy/master/index.html), so we can all play with the current state of the project & examples per branch, without installing everything locally.