node package manager
Stop wasting time. Easily manage code sharing in your team. Create a free org ยป

yaas

YAAS.js (Yet another asset server)

Join the chat at https://gitter.im/r1cebank/yaas codecov.io Dependencies Circle CI Inline docs Stories in Ready

Important notice: yaas is using redis for job queue, you will have to install redis before using yaas.

Detailed Documentation on readme.io

  1. Overview
    1. Installation
    2. Build and Run
    3. Configuration
    4. Documentation
  2. Who am I?
  3. Todo list
  4. Copyright

Overview

YAAS is a complete ready-to-use asset server that support file versioning as well as data manipulation

Example http://localhost:3939/buckets/rai/261671.jpeg?scale=0.5&crop=[200,200]

(this will get the jpeg named 261671 and apply 0.5 scale and crop 200x200 pixels from the center)

There are no external runtime dependencies, you don't need to install anything extra to use this.

This module is actively developed by Siyuan Gao.

Installation

  1. Download the package in .zip
  2. npm install
  3. npm install -g gulp
  4. You can run the tests with npm test

or...

  1. run npm install yaas
  2. the install script will run and prompt for configuration
  3. follow the instructions
  4. run yaas!

Build and run

  1. Run gulp
  2. Run node ./build

Configuration

YAAS is very configurable, but minminal configuration is needed to run on your system.

Documentation

yaas uses readme.io for documentation, to learn more about yaas, please go to http://yaas.readme.io

Who am I?

I am Siyuan Gao, a Mobile application developer, full-stack developer, designer from Vancouver, BC. I creates projects all the time for fun, or just because I want to bring a tool to life. To contact me, please email me at: siyuangao at gmail d0t c0m

Todo list

  1. Make the project more stuctured, (no more big source files)
  2. Make adding transformation easier
  3. Allow user to config authentication
  4. HTTPS support
  5. Better manage disk space
  6. More Mocha tests (**sorry, need to write more tests)

If you want to help out, feel free to fork and send me a pull request.

Coverage graph

codecov.io

Copyright

The MIT License (MIT)

Copyright (c) 2015 Siyuan Gao

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.