ibm-watson-data-lab / shopping-list-emberjs-pouchdb Goto Github PK

Copy the README template outline to this project's README. Fleshing out each section is addressed as separate issues.

Using the CONTRIBUTING template for reference, create a CONTRIBUTING.md file with the following:

• Welcoming introduction
• Proposing new features section
• Fixing bugs section
• Merge approval section
• Setup section

Using the README template for reference, change the following in the "Run locally" section of the README:

• Change the repo name in the "clone the repo" section.
• Change the "install the prerequisites" section as needed.
• Change the "run the server" section as needed.
• Change the "Create a Cloudant or CouchDB service" section as needed.

Enable deployment to IBM Cloud. This should be implemented as a Node.js app that serves static files, likely using Express. The Polymer + PouchDB implementation can be use for reference:
https://github.com/ibm-watson-data-lab/shopping-list-polymer-pouchdb/blob/master/app.js

Note that this is just one deployment option. The app can still be deployed to GitHub Pages or simply run locally.

Using the README template for reference, pick relevant resources to add to the "Learn more" section of the README.

Using the MAINTAINERS template for reference, create a MAINTAINERS.md file with the following:

• Introduction
• Methodology
• Merge approval
• Reviewing Pull Requests

• Ensure that a LICENSE file has been added that licenses this code under the Apache License 2.0.
• Ensure that a "License" section is included in the README, using the README template for reference.

• Produce a short demo video (example: https://youtu.be/hsq0sUAM-1I)
• Add a "Watch the Video" section to the README (example: https://github.com/ibm-watson-data-lab/shopping-list-polymer-pouchdb/blob/master/README.md#watch-the-video)

Using the README template for reference, change the following in the "Database and replication setup" section of the README:

• Ensure that the referenced screenshots are added to the repository.
• Change the "create the remote database" section as needed.
• Change the "enable CORS" section as needed.
• Change the "set the replication target" section as needed.

Using the README template for reference, change the following in the "Using the app" section of the README:

• Change the introductory section as needed.
• Ensure that the referenced screenshot is added to the repository.
• Write the "running the app" section.
• Write the "running the tests" section.
• Write the "deploying to GitHub Pages" section.

Using the README template for reference, add badges to the top of the README being sure to:

• Change the "Build Status" badge repository source URL.
• Change the "Build Status" badge repository link URL.
• Change the "IBM Cloud Deployments" badge tracking number in the URL.

Ensure that code is well documented and useful as a reference implementation.

Using the README template for reference, add any relevant links to the "Links" section of the README.

Ensure that there are no "IBM Bluemix" or "Bluemix" references and that instead we say "IBM Cloud" in all places.

Review to ensure compliance with IBM Code Pattern standards, compliance with our team's established standards for these demo apps, and overall quality.

• Set up unit testing
• Set up Travis CI integration

Integrate deployment tracking with the new metrics tracker maintained by the Digital Business Group.

Add a tutorial section to the README, if applicable, which says:

Refer to the tutorial for step-by-step instructions on how to build your own Offline First shopping list Progressive Web App with Ember.js and PouchDB.

Using the README template for reference, change the following in the "Deploy to IBM Cloud" section of the README:

• Change the "Deploy to IBM Cloud" button source URL.
• Change the "Deploy to IBM Cloud" button link URL.
• Update the app name.
• Update the prefix name.
• Document the service(s) created by the deployment.
• Test the "Deploy to IBM Cloud" button to ensure it works as expected.

Ensure that "JavaScript", not "Javascript" or "javascript," is used throughout the project.

Using the README template for reference, update the "Privacy Notice" section of the README as needed.

Using the README template for reference, change the following in the introductory section of the README:

• Change the title to indicate the technologies used.
• Change the first paragraph to indicate the technologies used.
• Document two or three goals for this Code Pattern.
• Produce an architecture diagram and add it to the correct path.
• Add the flow steps based on the architecture diagram.
• Add the included components.
• Add the featured technologies.
• Add the key concepts.

Ensure that an "About" (or similarly-titled) tab/page is added to the live demo version of the deployed app. Here is the boilerplate content that you can use for this tab/page:

Shopping List is a series of Offline First demo apps, each built using a different stack. These demo apps cover Progressive Web Apps, hybrid mobile apps, native mobile apps, and desktop apps. This particular demo app is a Progressive Web App built using Ember.js and PouchDB. Get the source code.