mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-24 10:47:44 +00:00
71 lines
2.4 KiB
Markdown
71 lines
2.4 KiB
Markdown
# uppy
|
|
|
|
A work in progress - nothing to see here.
|
|
|
|
## Design Goals
|
|
|
|
- Support for IE10+?? (decide what our entry level IE is, it's okay to have a cut-off if that results in a more focused higher quality codebase. older browsers will need to opt for our jquery-sdk)
|
|
- Lightweight / easy on dependencies
|
|
- tus.io enabled
|
|
- ES6
|
|
- Robust (retries / resumes for *all the things*), avoid showing 'weird errors'
|
|
- Themable UI with a beautiful default
|
|
- Compatible with React (Native)
|
|
- Should work great on mobile
|
|
- Small core, modular plugin architecture for everything: (modal / dragdrop / themes/ webcam / google drive / dropbox / etc)
|
|
- Offering sugared shortcuts for novice users (presets)
|
|
|
|
Check [open issues](https://github.com/transloadit/uppy/milestones/Minimum%20Viable%20Product) for our Minimum Viable Product.
|
|
|
|
## Uppy Development
|
|
|
|
First clone and install the project:
|
|
|
|
```bash
|
|
git clone git@github.com:transloadit/uppy.git
|
|
cd uppy
|
|
npm install
|
|
```
|
|
|
|
Now to get a sandbox environment set up, type:
|
|
|
|
```bash
|
|
npm run preview
|
|
```
|
|
|
|
This will `npm run build` the project into `./build`, and then serve that
|
|
directory using a simple static http server.
|
|
|
|
## Website Development
|
|
|
|
We keep the [uppyjs.io](http://uppyjs.io) website in `./website` for now so it's very easy to keep docs & code in sync as we're still
|
|
iterating at high velocity.
|
|
|
|
This site is built with [hexo](http://hexo.io/). And deployed onto GitHub pages (`gh-pages` branch is of the `uppy` repo is overrwitten at every deploy. Site content is written in Markdown format located in `./website/src`. Pull requests welcome!
|
|
|
|
The website is currently a clone of Yuxi Evan You's [Vue.js](http://vuejs.org/) website ([view license](website/LICENSE)) - just so we can hit the ground rolling in terms of setting up Haxo etc. Obviously as soon as possible, we should start rolling out our own layout & content.
|
|
|
|
For local previews on `localhost:4000` type:
|
|
|
|
```bash
|
|
make website-preview
|
|
```
|
|
|
|
To deploy your work type
|
|
|
|
```bash
|
|
make website-deploy
|
|
```
|
|
|
|
## FAQ
|
|
|
|
### What does Travis do?
|
|
|
|
Travis should:
|
|
|
|
- [x] check out code
|
|
- [x] build project
|
|
- [ ] run unit tests
|
|
- [ ] run acceptance tests
|
|
- [x] copy/install the built project into any `examples/*/`
|
|
- [x] 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.
|