uppy/README.md

uppy

A work in progress - nothing to see here.

Interesting places if you want to dig in:

• Architecture in website/src/api/index.md
• Contributor's guide in website/src/guide/contributing.md
• Open issues before having a Minimum Valuable Product.

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 web-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 with Hexo's build at every change to master). The content is written in Markdown and located in ./website/src. Feel free to fork & hack!

Even though bundled in this repo, the website is regarded as a separate project. So it has its own package.json and we aim keep the surface where the two projects interface as small as possible. ./website/update.js is called during website builds to inject the Uppy knowledge into the site.

Getting started

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 web-preview

This will start Hexo and rebuilds the site as you save. If you also want to work on examples / Uppy itself you then open a second tab in which you type:

make watch

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.