Skip to content

Commit b6dba80

Browse files
committed
docs: add quickstart to README
1 parent d05bbb2 commit b6dba80

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
1-
# Bluemix GraphQL Data Source: CloudFoundryApp
1+
# Bluemix GraphQL Data Source Base
22

3-
This data source exposes parts of the [Cloud Foundry API](https://apidocs.cloudfoundry.org/253/) via the [Bluemix GraphQL](https://github.ibm.com/bluemix/graphql) µ-service.
3+
- Provides templates for npm, Travis CI, and SonarQube
4+
- Provides TODO comments next to all items that need to be edited
5+
- Starts with the simplest possible example code to limit how much boilerplate editing is required
6+
- Starts you off right with test coverage at 💯
7+
- Provides testing helpers for common resolver testing patterns
8+
- Comes with docs! https://ibm.biz/graphql-data-source
49

5-
For more information about what data sources are and how they work, see https://ibm.biz/graphql-data-source
10+
## Quickstart
611

7-
## Development
12+
```sh
13+
# Clone the repo
14+
git clone [email protected]:Bluemix/graphql-data-source-base.git graphql-data-source-YOUR_DATA_SOURCE_NAME
815

9-
First, clone the repository and install dependencies:
16+
# Move into it
17+
cd graphql-data-source-YOUR_DATA_SOURCE_NAME/
1018

11-
```sh
12-
# Clone the repo and move into the directory folder
13-
git clone [email protected]:bluemix/graphql-data-source-cloudfoundryapp.git
14-
cd graphql-data-source-cloudfoundryapp/
19+
# Change the remote repo
20+
git remote set-url origin [email protected]:Bluemix/YOUR_REPO_NAME.git
21+
22+
# Create a package.json
23+
cp package.TEMPLATE.json package.json
24+
25+
# IMPORTANT: Edit name, description, author, and repository in package.json
1526

1627
# Install dependencies
1728
npm install

0 commit comments

Comments
 (0)