cozy / cozy-template Goto Github PK

Deprecated use https://github.com/cpatchane/cozy-create-app. Template project to create an application for the Cozy Platform

Home Page: http://cozy.io

License: GNU Affero General Public License v3.0

JavaScript 91.85% HTML 7.16% CSS 0.99%

cozy developer-tools spa cozy-v3

cozy-template's Introduction

Cozy Template

⚠️ This repo is deprecated. Prefer to use https://github.com/cpatchane/cozy-create-app ⚠️

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 cozy-template?

This repository is a client-side app skeleton for Cozy Cloud^v3. We keep it up-to-date with our habits and best-practices. It allow you to bootstrap an app from scratch in a breeze.

Use it

Step 1: clone the app

$ git clone \
  --origin=template \
  --depth=1 \
  https://github.com/cozy/cozy-template.git \
  my-app

Step 2: customize templates resources

The my-app/.templates dir contains some templates you can use in your final repository. You should copy them to the root of your project (excepted the .transifexrc file). Be careful that those files contains some vars you must replace to have the files fully functional:

<APP_NAME>: the application name
<APP_SHORT_DESCRIPTION>: a quick app description
<APP_CATEGORY>: the app category (used in the cozy-bar apps navigation)
<APP_MAINTAINER>: Github main maintainer username (don't forget @ :))
<SLUG_TX>: transifex app slug
<SLUG_GH>: Github repository slug
<SLUG_NPM>: NPM slug
<USERNAME_GH>: Github username

Don't forget to update your LICENSE too if needed.

⚠️ Concerning the application category, for now just cozy and partners are handled. Other categories will be handled soon, for now, you can let this field blank, it will be in the others category. If a category is empty, missing or not recognized, it will be others by default.

Step 3: add your own repository

Go to https://github.com/new and create a new repository for your app. Then add it to your app:

$ git remote add \
  origin \
  https://github.com/<USERNAME_GH>/<SLUG_GH>.git
$ git commit -am "Initial commit for my-app"
$ git push -u origin master:master

That's it 🚀!

Congrats! Your app is now fully set. You can start coding in src, and run it through a cozy-stack.

You can find more informations about how to bootstrap a Cozy app in the Cozy's app bootstrap^v3 talk.

Community

Maintainer

The lead maintainer for cozy-template and tooling is @m4dz, send him 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-template is developed by Cozy Cloud and distributed under the AGPL v3 license.

cozy-template's People

Contributors

Stargazers

Watchers

Forkers

poupotte cozy-labs m4dz rahmangithub cylwin michielbdejong nono pkdevbox fastclemmy kosssi khaoulazitoun gregorylegarec y-lohse cpatchane paultranvan rikterbeek

cozy-template's Issues

Remove mention to MAIF in Spinner

https://github.com/cozy/cozy-template/blob/24a22ae8770ae5abc8b53fe33e2775164b176bc2/src/components/Spinner.jsx

What about create-react-app ?

Has anyone tried create-react-app, it seems to be quite good and seem to help a lot for adoption of the React ecosystem.

https://facebook.github.io/react/blog/2017/05/18/whats-new-in-create-react-app.html

https://news.ycombinator.com/item?id=14373178

It's hard to make something like cozy-template with good defaults, maybe we could piggyback on the work of create-react-app to make something like create-cozy-app ?

Implement HMR for style

Can work from this commit https://gitlab.cozycloud.cc/ptbrowne/cozy-maif/commit/26e43b3729527b70a288d3c52ddb1964d5d1c8cc

Add documentation on new Cozy Template

https://github.com/cozy/cozy-template/tree/preact

folders architectures
commands

Where is the Cozy README ?

Abstract npm scripts into cozy-cli ?

We now have several apps that share a common set of scripts. This shared logic is difficult to keep coherent between the apps.

Maybe a CLI cozy could help with that.

cozy build
cozy deploy
cozy watch

Is there any inconvenient I do not see ?

Sample package.json.scripts

{
    "build": "npm run build:browser",
    "build:browser": "NODE_ENV=browser:production npm run commons:build",
    "build:mobile": "NODE_ENV=mobile:production npm run commons:build",
    "clean:browser": "rm -rf build/*",
    "clean:mobile": "rm -rf mobile/www/*",
    "commons:build": "webpack --config webpack.config.js --bail",
    "commons:watch": "webpack --config webpack.config.js --watch --display-modules --display-chunks",
    "commons:watch:standalone": "webpack-dev-server --config webpack.config.js --display-modules --display-chunks --inline --hot",
    "deploy": "git-directory-deploy --username Cozy --email [email protected] --directory build/ --repo=https://[email protected]/<USERNAME_GH>/<SLUG_GH>.git",
    "tx": "tx pull --all || true",
    "precommons:build": "npm-run-all lint tx",
    "prebuild:browser": "npm run clean:browser",
    "prebuild:mobile": "npm run clean:mobile",
    "pretest": "npm run lint",
    "prewatch:browser": "npm run clean:browser",
    "prewatch:mobile": "npm run clean:mobile",
    "lint": "npm-run-all --parallel 'lint:*'",
    "lint:js": "eslint 'src/**/*.js' 'src/**/*.jsx' 'test/**/*.js' 'mobile/src/**/*.js' 'mobile/src/**/*.jsx' 'mobile/test/**/*.js'",
    "lint:styles": "stylint src/styles --config ./.stylintrc",
    "stack:docker": "docker run --rm -it -p 8080:8080 -v \"$(pwd)/build\":/data/cozy-app/app cozy/cozy-app-dev",
    "test": "node --harmony_proxies node_modules/.bin/jest",
    "watch": "npm run watch:browser",
    "watch:browser": "NODE_ENV=browser:development npm run commons:watch",
    "watch:mobile": "NODE_ENV=mobile:development npm run commons:watch",
    "watch:browser:standalone": "NODE_ENV=browser:development npm run commons:watch:standalone",
    "watch:mobile:standalone": "NODE_ENV=mobile:development npm run commons:watch:standalone",
    "watch:standalone": "npm run watch:browser:standalone",
    "android:run": "cd mobile ; cordova run android --device ; cd ..",
    "android:run:emulator": "cd mobile ; cordova run android --emulator ; cd ..",
    "android:release": "npm run build:mobile && cd mobile ; cordova build android --release ; cd ..",
    "android:signed": "npm run android:release && cd mobile ; apksigner sign --ks keys/android/<APP_NAME>-release-key.jks --out build/android/<APP_NAME>.apk platforms/android/build/outputs/apk/android-release-unsigned.apk ; cd ..",
    "android:publish": "npm run android:signed && cd mobile ; fastlane supply ; cd ..",
    "ios:run": "cd mobile ; cordova run ios --device ; cd ..",
    "ios:run:emulator": "cd mobile ; cordova run ios --emulator ; cd .."
}

client package.json dependency mistake

Hi,

the client/package.json dependency to brunch is badly written as "bruch"

Thanks

Better explanations about the node version

The template does not work if you run it with node 4