Skip to content
The Uploadcare Widget
CoffeeScript CSS HTML Ruby JavaScript
Latest commit 7323a40 Jun 7, 2016 @homm homm Merge pull request #346 from uploadcare/disable-imageSmoothing-in-chrome
Disable imageSmoothingQuality in Chrome due to worst quality
Failed to load latest commit information.
app/assets
lib
script
submodules
test version May 13, 2016
.gitignore
.gitmodules
.travis.yml
Gemfile
Gemfile.lock
HISTORY.markdown
LICENSE
README.markdown
Rakefile
Vagrantfile fix Vagrant provision, update README Mar 28, 2016
package.json
uploadcare-widget.gemspec use modern js and css optimizers Mar 14, 2016

README.markdown

This is the Uploadcare widget source.

Build Status

Embedding

Add following code to your document's <head>.

<script>
  // Widget settings
  UPLOADCARE_PUBLIC_KEY = 'your_public_key';
</script>
<script src="https://ucarecdn.com/widget/x.y.z/uploadcare/uploadcare.full.min.js" charset="utf-8"></script>

Where x.y.z is widget version (2.0.6 for example). Here is also version without builtin jQuery:

<script>
  // Widget settings
  UPLOADCARE_PUBLIC_KEY = 'your_public_key';
</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js" charset="utf-8"></script>
<script src="https://ucarecdn.com/widget/x.y.z/uploadcare/uploadcare.min.js" charset="utf-8"></script>

The official Widget documentation has more information on using the widget itself.

Using with Bower

Install uploadcare using bower command:

$ bower install uploadcare

Add following code to your document's <head>.

<script>
  // Widget settings
  UPLOADCARE_PUBLIC_KEY = 'your_public_key';
  // To use static content from your host   
  UPLOADCARE_SCRIPT_BASE = '/bower_components/uploadcare/';
</script>
<script src="/bower_components/jquery/jquery.js" charset="utf-8"></script>
<script src="/bower_components/uploadcare/uploadcare.js" charset="utf-8"></script>

Using with npm

Install uploadcare using npm command:

$ npm install uploadcare-widget

Add following code to your document's <head>.

<script>
  // Widget settings
  UPLOADCARE_PUBLIC_KEY = 'your_public_key';
  // To use static content from your host   
  UPLOADCARE_SCRIPT_BASE = '/node_modules/uploadcare-widget/';
</script>
<script src="/node_modules/jquery/jquery.js" charset="utf-8"></script>
<script src="/node_modules/uploadcare-widget/uploadcare.js" charset="utf-8"></script>

Building Your Own

Clone the repository.

Enviroment

You need a working Ruby 2.0.0 and above environment with Bundler.

Vagrant

If you don't want to raise the environment on your machine, you can use Vagrant. Just install Vagrant and VirtualBox or other provider.

After open command line, go to this folder and run:

vagrant up
vagrant ssh

Local environment (without Vagrant)

Inside folder run

bundle install
cd ./test/dummy
bundle install

Build

  • bundle exec rake js:latest:build to build assets to the pkg/latest directory (with the “latest” suffix).
  • bundle exec rake js:release:build to build assets to the pkg/version folder (with the current version suffix). The version is specified in lib/uploadcare-widget/version.rb.

Development

Go to test/dummy/. There is a simple Rails app. Run it:

bundle exec rails server

Open http://127.0.0.1:3000/. Follow any link. There's going to be a widget or three. Edit code and reload page :-)

Testing

Jasminerice installed under the test/dummy/ Rails app.

To run tests in your browser go to http://127.0.0.1:3000/jasmine.

For more information see jasminerice docs.

guard-jasmine

To run tests in a terminal you must first install phantomjs.

Then you have two options:

  • run bundle exec guard start
  • run bundle exec guard-jasmine

The first one is for continuous tests execution, the second one runs tests just once. Both should be executed from the test/dummy/ directory.

See guard-jasmine docs for more information.

Something went wrong with that request. Please try again.