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.
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
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
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
app.cozy.local to your
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
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.
$ cd cozy-files-v3 $ yarn test
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.
Localization and translations are handled by Transifex, which is used by all Cozy's apps.
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.
The lead maintainer for Cozy Files is @GoOz, send him/her a
Get in touch
You can reach the Cozy Community by:
- Chatting with us on IRC #cozycloud on Freenode
- Posting on our Forum
- Posting issues on the Github repos
- Say Hi! on Twitter
Cozy Files is developed by Cozy Cloud and distributed under the AGPL v3 license.