coeur v0.2.313

Coeur MVP Kit

Welcome! Coeur is a resource for jumpstarting MVPs and side projects. Coeur is a living document — use it as a starting point, and modify to your own needs!

For the current WIP, please visit https://coeur.surge.sh

Old docs: https://stylecoeur.surge.sh

Background

Coeur started as a toolbox to speed up my work process, as a style guide and reusable javascript library. Since then, it has grown into a larger collection of opinions, ideas, examples, and resources on how to design, prototype and launch new projects.

Use Coeur as a starting point for your own toolbox.

• Coeur is not a framework or a design system — it's a few resources for starting MVPs
• Coeur focuses on building MVPs with Middleman and Jekyll site generators, and Vue / Nuxt for single page app experiences.
• Coeur prefers working with serverless tools like Webtask or Glitch
• The documentation and examples can be used as a starting point for your projects
• Clone the github repository to run the documentation locally, or to try the examples
• package.json contains npm shortcuts to run or deploy the documentation
• Each example folder contain their own installation notes package.json with commands to run the respective generators
• The docs run on Nuxt and requires npm v8. Try installing nvm and running: nvm use 8.11.2
• Check the documentation site (https://zeee.co/coeur) for additional guidance

Commands

These convenience commands are helpful for general project development. Check them out in package.json and make them your own.

# install dependencies after copied or downloaded
$ npm install # Or yarn install

# serve with hot reload at localhost:7711 (change in package.json)
$ npm run dev

# commits and pushes changes to github (for lazy people; requires setup)
$ npm run commit

# deploy to stage server (I use surge, but you may use Now or anything else)
$ npm run surge

# deploy to production server (uses surge by default)
$ npm run deploy


# build for production and launch server
$ npm run build
$ npm start

# generate static project
$ npm run generate