<commit_before>[![Travis build status shield](https://img.shields.io/travis/cozy/cozy-files-v3.svg?branch=master)](https://travis-ci.org/cozy/cozy-files-v3)
[![NPM release version shield](https://img.shields.io/npm/v/cozy-files-v3.svg)](https://www.npmjs.com/package/cozy-files-v3)
[![Github Release version shield](https://img.shields.io/github/tag/cozy/cozy-files-v3.svg)](https://github.com/cozy/cozy-files-v3/releases)
[![NPM Licence shield](https://img.shields.io/npm/l/cozy-files-v3.svg)](https://github.com/cozy/cozy-files-v3/blob/master/LICENSE)


[Cozy] Files
=======================


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

_:pushpin: Note:_ we recommend to use [Yarn] instead of NPM for package management. Don't hesitate to [install][yarn-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][setup].

You can then clone the app repository and install dependencies:

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

:pushpin: If you use a node environment wrapper like [nvm] or [ndenv], don't forget to set your local node version before doing a `yarn install`.

Cozy's apps use a standard set of _npm scripts_ to run common tasks. You can so start you development workflow with:

```sh
$ cd cozy-files-v3
$ yarn run watch:server
```

and point your browser to http://localhost:8082.


#### Note about Cozy-ui

[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 link
```

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

```sh
cd cozy-files-v3
yarn link cozy-ui<commit_msg>[docs] enforce to checkout cozy-ui@v3 at clone<commit_after>[![Travis build status shield](https://img.shields.io/travis/cozy/cozy-files-v3.svg?branch=master)](https://travis-ci.org/cozy/cozy-files-v3)
[![NPM release version shield](https://img.shields.io/npm/v/cozy-files-v3.svg)](https://www.npmjs.com/package/cozy-files-v3)
[![Github Release version shield](https://img.shields.io/github/tag/cozy/cozy-files-v3.svg)](https://github.com/cozy/cozy-files-v3/releases)
[![NPM Licence shield](https://img.shields.io/npm/l/cozy-files-v3.svg)](https://github.com/cozy/cozy-files-v3/blob/master/LICENSE)


[Cozy] Files
=======================


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

_:pushpin: Note:_ we recommend to use [Yarn] instead of NPM for package management. Don't hesitate to [install][yarn-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][setup].

You can then clone the app repository and install dependencies:

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

:pushpin: If you use a node environment wrapper like [nvm] or [ndenv], don't forget to set your local node version before doing a `yarn install`.

Cozy's apps use a standard set of _npm scripts_ to run common tasks. You can so start you development workflow with:

```sh
$ cd cozy-files-v3
$ yarn run watch:server
```

and point your browser to http://localhost:8082.


#### Note about Cozy-ui

[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 -b v3
cd cozy-ui
yarn link
```

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

```sh
cd cozy-files-v3
yarn link cozy-ui
{'fraction_non_alphanumeric': 0.12525364323925475, 'fraction_numerical': 0.006271905552481092, 'mean_word_length': 3.9788797061524335, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 22, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4832087', 'n_tokens_mistral': 1772, 'n_tokens_neox': 1650, 'n_words': 653}