[deprecated] This repo has been merged in https://github.com/cozy/cozy-drive

Cozy Photos

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

Cozy Photos make your photos and albums easy to manage. Main features are:

• Photos timeline
• Albums
• Photos sharing

Hack

📌 Note: we recommend to use Yarn instead of NPM for package management. Don't hesitate to 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 Photos 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-photos-v3.git
$ cd cozy-photos-v3
$ yarn install

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

⚠️ During its early ages, cozy-photos-v3 uses beta versions of cozy-ui and cozy-client-js, take a look at the "living on the edge" note below to know hot to install and configure the latest available versions.

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

$ cd cozy-photos-v3
$ yarn run watch:server

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

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-photos-v3
$ yarn run watch

# in another terminal, run the docker container
$ docker run --rm -it -p 8080:8080 -v "$(pwd)/build":/data/cozy-app/photos cozy/cozy-app-dev
or
$ yarn stack:docker

your app is available at http://photos.cozy.tools:8080.

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

Tests

Tests are run by jest using rendering features from enzyme. You can easily run the tests suite with:

$ cd cozy-photos-v3
$ yarn test

You can also run the test in a watching mode by using yarn run test -- --watch.

Components tests using jest work with snapshots, it allows to assert rendered components in an easier way. After a new feature, only if you are sure that the new rendered component received from the test is correct, use yarn run test -- -u to update obsolete snapshots.

⚠️ Be careful when you update snapshots, if the rendered components are incorrect, the related snapshots will be updated with incorrect components and the related tests will used incorrect snapshots. And we won't see tests errors about that.

📌 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 Photos 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 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.

Maintainer

The lead maintainer for Cozy Photos is @goldoraf, send him/her a 🍻 to say hello!

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

License

Cozy Photos is developed by Cozy Cloud and distributed under the AGPL v3 license.