Cozy Files app for Cozy Cloud
JavaScript CSS Ruby HTML Smarty
Pull request Compare This branch is even with cozy:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.tx
__mocks__
config
mobile
src
test
vendor/assets
.babelrc
.editorconfig
.gitignore
.transifexrc.tpl
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
manifest.webapp
package.json
postcss.config.js
webpack.config.js
yarn.lock

README.md

Travis build status shield NPM release version shield Github Release version shield NPM Licence shield

Cozy Files

What's Cozy?

Cozy Logo

Cozy is a platform that brings all your web services in the same private space. With it, your webapps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one's tracking you.

What's Files?

Cozy Files makes your file management easy. Main features are:

  • File tree
  • Files and folders upload.
  • Files and folders sharing (via URLs)
  • Files and folders search

Hack

📌 Note: we recommend to use Yarn instead of NPM for package management. Don't hesitate to install and use it for your Cozy projects, it's now our main node packages tool for Cozy official apps.

Install and run in dev mode

Hacking the Files app requires you to setup a dev environment.

You can then clone the app repository and install dependencies:

$ git clone https://github.com/cozy/cozy-files-v3.git
$ cd cozy-files-v3
$ yarn install

📌 If you use a node environment wrapper like nvm or ndenv, don't forget to set your local node version 6 before doing a yarn install.

⚠️ During its early ages, cozy-files-v3 uses beta versions of cozy-ui and [cozy-client-js], take a look at the "living on the edge" note below to know hot to install and configure the latest available versions.

Cozy's apps use a standard set of npm scripts to run common tasks, like watch, lint, test, build…

Run it inside the VM

You can easily view your current running app, you can use the cozy-stack docker image:

# in a terminal, run your app in watch mode
$ cd cozy-files-v3
$ yarn run watch
# in another terminal, run the docker container
$ docker run --rm -it -p 8080:8080 -v "$(pwd)/build":/data/cozy-app cozy/cozy-app-dev

⚠️ Don't forget to add cozy.local and app.cozy.local to your /etc/hosts

127.0.0.1 cozy.local
127.0.0.1 app.cozy.local

your app is available at http://app.cozy.local:8080.

Run on you mobile phone or your tablet ☎️

See specific documentation.

Living on the edge

Cozy-ui is our frontend stack library that provides common styles and components accross the whole Cozy's apps. You can use it for you own application to follow the official Cozy's guidelines and styles. If you need to develop / hack cozy-ui, it's sometimes more useful to develop on it through another app. You can do it by cloning cozy-ui locally and link it to yarn local index:

git clone https://github.com/cozy/cozy-ui.git -b v3
cd cozy-ui
yarn install
yarn link

then go back to your app project and replace the distributed cozy-ui module with the linked one:

cd cozy-files-v3
yarn link cozy-ui

You can now run the watch task and your project will hot-reload each times a cozy-ui source file is touched.

[Cozy-client-js] is our API library that provides an unified API on top of the cozy-stack. If you need to develop / hack cozy-client-js in parallel of your application, you can use the same trick that we used with cozy-ui: yarn linking.

Tests

Tests are run by mocha under the hood, and written using chai and sinon. You can easily run the tests suite with:

$ cd cozy-files-v3
$ yarn test

📌 Don't forget to update / create new tests when you contribute to code to keep the app the consistent.

Resources

All documentation is located in the /docs app directory. It provides an exhaustive documentation about workflows (installation, development, pull-requests…), architecture, code consistency, data structures, dependencies, and more.

Feel free to read it and fix / update it if needed, all comments and feedback to improve it are welcome!

Open a Pull-Request

If you want to work on Files and submit code modifications, feel free to open pull-requests! See the contributing guide for more information about how to properly open pull-requests.

Community

Localization

Localization and translations are handled by Transifex, which is used by all Cozy's apps.

As a translator, you can login to Transifex (using your Github account) and claim an access to the app repository. Locales are pulled when app is build before publishing.

As a developer, you must configure the transifex client, and claim an access as maintainer is the app repository. Then please only update the source locale file (usually en.json in client and/or server parts), and push it to Transifex repository using the tx push -s command.

Maintainer

The lead maintainer for Cozy Files is @GoOz, send him/her a 🍻 to say hello!

Get in touch

You can reach the Cozy Community by:

License

Cozy Files is developed by Cozy Cloud and distributed under the AGPL v3 license.