Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"bitwise": true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks :)

"curly": true,
"eqeqeq": true,
"esnext": true,
"freeze": true,
"immed": true,
"indent": 2,
"latedef": "nofunc",
"newcap": true,
"node": true,
"noarg": true,
"quotmark": "single",
"strict": true,
"trailing": true,
"undef": true,
"unused": true
}
21 changes: 0 additions & 21 deletions Gulpfile.js

This file was deleted.

139 changes: 80 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,88 +1,109 @@
gcloud-node-todos
=================
# gcloud-node-todos
> [TodoMVC](http://todomvc.com) backend using [gcloud-node](//github.com/GoogleCloudPlatform/gcloud-node).

[![Build Status](https://travis-ci.org/GoogleCloudPlatform/gcloud-node-todos.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/gcloud-node-todos)

TodoMVC backend using [gcloud-node](//github.com/GoogleCloudPlatform/gcloud-node).
## Examples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put that at the end.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

under 'Other Examples'


# API
- [Command Line](//github.com/GoogleCloudPlatform/gcloud-node-todos/cli)

- Insert a todo
Have an idea for a new implementation? Please [raise an issue](//github.com/GoogleCloudPlatform/gcloud-node-todos/issues/new).

curl -X POST -d '{text: "do this"}' http://localhost:8080/todos
## API

- Get a todo
#### Insert a todo
```sh
$ curl -X POST -H "Content-Type: application/json" -d '{"text": "do this"}' http://localhost:8080/todos
```

curl -X GET http://localhost:8080/todos/{{todo id}}
#### Get a todo
```sh
$ curl -X GET http://localhost:8080/todos/{{todo id}}
```

- Mark a todo as done
#### Mark a todo as done
```sh
$ curl -X PUT -H "Content-Type: application/json" -d '{"text": "do this", "done": true}' http://localhost:8080/todos/{{todo id}}
```

curl -X PUT -d '{text: "do this", "done": true}' http://localhost:8080/todos/{{todo id}}
#### Delete a todo
```sh
$ curl -X DELETE http://localhost:8080/todos/{{todo id}}
```

- Delete a todo
#### Get all todos
```sh
$ curl -X GET http://localhost:8080/todos
```

curl -X DELETE http://localhost:8080/todos/{{todo id}}
#### Clear all `done` todos
```sh
$ curl -X DELETE http://localhost:8080/todos
```

- Get all todos

curl -X GET http://localhost:8080/todos
## Prerequisites

- Clear all `done` todos
1. Create a new cloud project on [console.developers.google.com](http://console.developers.google.com)
2. [Enable](https://console.developers.google.com/flows/enableapi?apiid=datastore) the [Google Cloud Datastore API](https://developers.google.com/datastore)
3. Create a new service account and copy the JSON credentials to `key.json`
4. Export your project id:
```sh
$ export PROJECT_ID=<project id>
```

curl -X DELETE http://localhost:8080/todos
## Running

# Prerequisites
#### Locally
```sh
# Set your default Dataset
$ export DATASET_ID=$PROJECT_ID

- Create a new cloud project on [console.developers.google.com](http://console.developers.google.com)
- [Enable](https://console.developers.google.com/flows/enableapi?apiid=datastore) the [Google Cloud Datastore API](https://developers.google.com/datastore)
- Create a new service account and copy the `JSON` credentials to `key.json`
- Export your project id

export PROJECT_ID=<project id>
# Install the dependencies
$ npm install

# Run locally
# Start the server
$ npm start

# set your default dataset
export DATASET_ID=$PROJECT_ID
# fetch the dependencies
npm install
# start the app
npm start
# run acceptance test
dredd todos.apib http://localhost:8080 --hookfiles test_hooks.js
# Run acceptance test
$ npm test
```

# Run in docker
#### [Docker](https://docker.com)
```sh
# Check that Docker is running
$ boot2docker up
$ export DOCKER_HOST=$(boot2docker shellinit)

# check that docker is running
boot2docker up
export DOCKER_HOST=$(boot2docker shellinit)
# Build your Docker image
$ docker build -t app .

# build your docker image
docker build -t app .
# start a new docker container
docker run -e DATASET_ID=$PROJECT_ID -p 8080:8080 app
# Start a new Docker container
$ docker run -e DATASET_ID=$PROJECT_ID -p 8080:8080 app

# test the app
curl -X GET http://$(boot2docker ip):8080
# Test the app
$ curl -X GET http://$(boot2docker ip):8080
```

# Run w/ [Managed VMs](https://developers.google.com/appengine/docs/managed-vms/)
#### [Managed VMs](https://developers.google.com/appengine/docs/managed-vms/)
```sh
# Get gcloud
$ curl https://sdk.cloud.google.com | bash

# get gcloud
curl https://sdk.cloud.google.com | bash
# authorize gcloud and set your default project
gcloud auth login
gcloud config set project $PROJECT_ID
# Authorize gcloud and set your default project
$ gcloud auth login
$ gcloud config set project $PROJECT_ID

# get managed vms component
gcloud components update app-engine-managed-vms
# Get Managed VMs component
$ gcloud components update app-engine-managed-vms

# check that docker is running
boot2docker up
# Check that Docker is running
$ boot2docker up

# run the app locally
gcloud preview app run .
curl -X GET http://localhost:8080
# Run the app locally
$ gcloud preview app run .
$ curl -X GET http://localhost:8080

# deploy the app to production
gcloud preview app deploy .
curl -X GET http://$PROJECT_ID.appspot.com
# Deploy the app to production
$ gcloud preview app deploy .
$ curl -X GET http://$PROJECT_ID.appspot.com
```
12 changes: 12 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Command Line Example

## Running

```sh
# From the `gcloud-node-todos` root directory:
$ npm link
$ cd cli
$ npm link gcloud-node-todos
$ npm link
$ datastore-todos
```
Loading