Cozy Drive
What's Cozy?
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 Drive?
Cozy Drive 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
Install and run in dev mode
Hacking the Drive 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-drive.git
$ cd cozy-drive
$ yarn install
8 before doing a 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-drive
$ yarn watch:drive:browser
# in another terminal, run the docker container
$ docker run --rm -it -p 8080:8080 -v "$(pwd)/build/drive":/data/cozy-app/drive cozy/cozy-app-dev
your app is available at http://drive.cozy.tools:8080.
Share and send mails in development
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
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-drive
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-drive
$ yarn test
Open a Pull-Request
If you want to work on Drive 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 to 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 Drive is @GoOz, send him/her a
Get in touch
You can reach the Cozy Community by:
- Chatting with us on IRC #cozycloud on Libera.Chat
- Posting on our Forum
- Posting issues on the Github repos
- Say Hi! on Twitter
License
Cozy Drive is developed by Cozy Cloud and distributed under the AGPL v3 license.
1.4k Jan 7, 2023
163 Dec 29, 2022
18 Aug 10, 2022
12 Feb 10, 2022
6 Oct 8, 2022
12 Jul 29, 2022
11 Dec 21, 2022
397 Dec 31, 2022
31 Nov 24, 2022
0 Mar 11, 2022
1 Jan 3, 2023
2 Feb 16, 2022
33 Dec 21, 2022
13 Nov 1, 2022
115 Dec 28, 2022
21 Sep 13, 2022
0 Dec 19, 2021
2 Jun 9, 2022
256 Oct 6, 2022
195 Nov 29, 2021