twake-drive

Twake Drive

About

What's Drive?

Twake 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 Twake Drive. Don't hesitate to install Yarn

Install

Starting 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/linagora/twake-drive.git
$ cd twake-drive
$ yarn install

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

Twake Drive 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:

$ cd twake-drive
$ yarn watch
$ cozy-stack serve --appdir drive:/<project_absolute_path>/twake-drive/build/drive --disable-csp

Or directly build the app (static file generated):

$ cd twake-drive
$ yarn build
$ cozy-stack serve --appdir drive:/<project_absolute_path>/twake-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 view your current running app, you can use the cozy-stack docker image:

# in a terminal, run your app in watch mode
$ cd twake-drive
$ yarn watch

# 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

Twake Drive let users share documents from twake to twake.

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 twake to enter his own twake url to link both twakes. Bob sees Alice's shared folder in his own twake.

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

If you develop with the cozy-stack CLI, you have to run MailHog on your computer and tell cozy-stack serve where to find the mail server with some options:

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

This commands assumes you git clone twake-drive in the same folder than you git clone 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 Twake React apps. You can use it for you own application to follow the official Twake'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 twake-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.

Error reporting

Error reporting is off unless the build is given a collector. Set SENTRY_DSN in the build environment and initSentry will report there; leave it unset and no reporter is initialised at all, which is what a deployment that must not send anything outside its own perimeter wants.

$ SENTRY_DSN='https://<key>@<your-collector>/<project>' yarn build

The CI build reads it from the SENTRY_DSN repository variable. It is a variable rather than a secret: the DSN ships inside the client bundle and is readable by anyone loading the app.

Reports are scrubbed before they leave the browser, see src/lib/sentryScrub.js: public pages authenticate with the sharecode carried in their URL, and download and thumbnail links hold their secret in the path.

Tests

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

$ cd twake-drive
$ yarn test

For Playwright end-to-end tests, see the E2E test guide.

: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 for more information about how to properly open pull-requests.

Community

Localization

Localization and translations are handled by Transifex.

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

As a developer, you must configure the Transifex CLI, and claim 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.

If you were using a transifex-client, you must move to Transifex 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/.

License

Twake Drive is developed by Linagora and distributed under the AGPL v3 license.