Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cozy/cozy-drive

Cozy Drive Web App for Cozy Cloud
https://github.com/cozy/cozy-drive

cozy drive file-manager

Last synced: 2 months ago
JSON representation

Cozy Drive Web App for Cozy Cloud

Awesome Lists containing this project

README 

        
[![Travis build status shield](https://img.shields.io/travis/cozy/cozy-drive.svg?branch=master)](https://travis-ci.org/cozy/cozy-drive)

[![Github Release version shield](https://img.shields.io/github/tag/cozy/cozy-drive.svg)](https://github.com/cozy/cozy-drive/releases)

[![NPM Licence shield](https://img.shields.io/github/license/cozy/cozy-drive.svg)](https://github.com/cozy/cozy-drive/blob/master/LICENSE)



[Cozy] Drive

=====



What's Cozy?

----



![Cozy Logo](https://cdn.rawgit.com/cozy/cozy-guidelines/master/templates/cozy_logo_small.svg)



[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



Getting Started

----



_:pushpin: Note:_ [Yarn] is the official Node package manager of Cozy. Don't hesitate to [install Yarn][yarn-install] and use it in any Cozy projects.



### Install



Starting the Drive app requires you to [setup a dev environment][setup].



You can then clone the app repository and install dependencies:



```sh

$ git clone https://github.com/cozy/cozy-drive.git

$ cd cozy-drive

$ yarn install

```



:pushpin: Don't forget to set the local node version indicated in the `.nvmrc` before doing a `yarn install`.



:warning: During its early ages, _cozy-drive_ uses beta versions of [cozy-ui] and [cozy-client-js], take a look at the ["living on the edge" note](#living-on-the-edge) below to know how 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 in dev mode



Using a watcher - with Hot Module Replacement:

```sh

$ cd cozy-drive

$ yarn watch

$ cozy-stack serve --appdir drive://cozy-drive/build/drive --disable-csp

```



Or directly build the app (static file generated):

```sh

$ cd cozy-drive

$ yarn build

$ cozy-stack serve --appdir drive://cozy-drive/build/drive

```



Your app is available at http://drive.cozy.localhost:8080/#/folder



Note: it's mandatory to explicit to cozy-stack the folder of the build that should be served, to be able to run the app.



### Run it inside the VM



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



```sh

# in a terminal, run your app in watch mode

$ cd cozy-drive

$ yarn watch

```



```sh

# 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.



Advanced case

----



### Share and send mails in development



Cozy apps let users [share documents from cozy to cozy](https://github.com/cozy/cozy-stack/blob/master/docs/sharing.md#cozy-to-cozy-sharing).



Meet Alice and Bob.

Alice wants to share a folder with Bob.

Alice clicks on the share button and fills in the email input with Bob's email address.

Bob receives an email with a _« Accept the sharing »_ button.

Bob clicks on that button and is redirected to Alice's cozy to enter his own cozy url to link both cozys.

Bob sees Alice's shared folder in his own cozy.



🤔 But how could we do this scenario on binary cozy-stack development environment?



If you develop with the [cozy-stack CLI](https://github.com/cozy/cozy-stack/blob/master/docs/cli/cozy-stack.md), you have to run [MailHog](https://github.com/mailhog/MailHog) on your computer and tell `cozy-stack serve` where to find the mail server with some [options](https://github.com/cozy/cozy-stack/blob/master/docs/cli/cozy-stack_serve.md#options):



```

./cozy-stack serve --appdir drive:../cozy-drive/build,settings:../cozy-settings/build --mail-disable-tls --mail-port 1025

```



_This commands assumes you `git clone` [cozy-drive](https://github.com/cozy/cozy-drive) and [cozy-settings](https://github.com/cozy/cozy-settings) in the same folder than you `git clone` [cozy-stack](https://github.com/cozy/cozy-stack)._



Then simply run `mailhog` and open http://cozy.tools:8025/.



#### Retrieve sent emails



With MailHog, **every email** sent by cozy-stack is caught. That means the email address *does not have to be a real one*, ie. `bob@cozy`, `[email protected]` are perfectly fine. It *could be a real one*, but the email will not reach the real recipient's inbox, say `[email protected]`.



### 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:



```sh

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:



```sh

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.



###### Troubleshooting

Consider using [rlink] instead of `yarn link`



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



### Tests



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



```sh

$ cd cozy-drive

$ yarn test

```



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



### 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][contribute] for more information about how to properly open pull-requests.



Community

---------



### Localization



Localization and translations are handled by [Transifex][tx].



As a _translator_, you can login to [Transifex][tx-signin] (using your Github account) and claim access to the [app repository][tx-app]. Locales are pulled [by the pipeline][yarn tx in travis.yml] when app is build before publishing.



As a _developer_, you must configure the [Transifex CLI][tx-cli], and claim access as _maintainer_ to the [app repository][tx-app]. 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.



If you were using a [transifex-client](tx-client), you must move to [Transifex CLI](tx-cli) to be compatible with the v3 API.



The transifex configuration file is still in an old version. Please use the previous client for the moment [https://github.com/transifex/transifex-client/](https://github.com/transifex/transifex-client/).



###### Drive specificity



CozyDrive and CozyPhotos share this mono-repository but the translations are split into two projects Transifex.

That is why the translation files are not present in this repository.



To update the translation in other language, make the changes directly on [tx-translate]. Select one language and click on **global**



### Maintainer



The lead maintainer for Cozy Drive is @Crash--, send him/her a :beers: to say hello!



### Get in touch



You can reach the Cozy Community by:



- Chatting with us on IRC [#cozycloud on Libera.Chat][libera]

- Posting on our [Forum][forum]

- Posting issues on the [Github repos][github]

- Say Hi! on [Twitter][twitter]



License

-------



Cozy Drive is developed by Cozy Cloud and distributed under the [AGPL v3 license][agpl-3.0].



[cozy]: https://cozy.io "Cozy Cloud"

[setup]: https://docs.cozy.io/en/tutorials/app/#install-the-development-environment "Cozy dev docs: Set up the Development Environment"

[yarn]: https://yarnpkg.com/

[yarn-install]: https://yarnpkg.com/en/docs/install

[cozy-ui]: https://github.com/cozy/cozy-ui

[rlink]: https://gist.github.com/ptbrowne/add609bdcf4396d32072acc4674fff23

[cozy-client]: https://github.com/cozy/cozy-client/

[cozy-stack-docker]: https://github.com/cozy/cozy-stack/blob/master/docs/client-app-dev.md#with-docker

[doctypes]: https://cozy.github.io/cozy-doctypes/

[bill-doctype]: https://github.com/cozy/cozy-konnector-libs/blob/master/models/bill.js

[konnector-doctype]: https://github.com/cozy/cozy-konnector-libs/blob/master/models/base_model.js

[konnectors]: https://github.com/cozy/cozy-konnector-libs

[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.html

[contribute]: CONTRIBUTING.md

[tx]: https://www.transifex.com/cozy/

[tx-signin]: https://www.transifex.com/signin/

[tx-app]: https://www.transifex.com/cozy/cozy-drive/dashboard/

[tx-translate]: https://www.transifex.com/cozy/cozy-drive/translate/

[tx-cli]: https://developers.transifex.com/docs/cli

[tx-client]: https://github.com/transifex/transifex-client

[libera]: https://web.libera.chat/#cozycloud

[forum]: https://forum.cozy.io/

[github]: https://github.com/cozy/

[twitter]: https://twitter.com/cozycloud

[nvm]: https://github.com/creationix/nvm

[cozy-dev]: https://github.com/cozy/cozy-dev/

[jest]: https://jestjs.io/fr/

[chai]: http://chaijs.com/

[sinon]: http://sinonjs.org/

[checkbox]: https://help.github.com/articles/basic-writing-and-formatting-syntax/#task-lists

[yarn tx in travis.yml]: .travis.yml#L41