Skip to content

Commit

Permalink
Merge pull request #50 from contentstack/feat/ECO-656_add_developer_t…
Browse files Browse the repository at this point in the history
…ools_extension

feat: add developer tools extension and update readme [ECO-656]
  • Loading branch information
karantalapalli authored May 2, 2022
2 parents 2195144 + 15ec7cd commit 6b8b705
Show file tree
Hide file tree
Showing 4 changed files with 531 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ This widget uses the Google Analytics data to display the traffic analysis and s
[Optimizely Experiments](./optimizely-experiments):
This extension lets you retrieve and display Optimizely Experiments and their details in your entry.

[Developer Tools](./developer-tools):
This widget extension provides developers with quick tools (API endpoint, JSON, etc.) to work with an entry or all entries of a content type and do a lot more.

### Examples of dashboard widgets created using Extensions

Here are some examples/use cases of dashboard widgets that can be created using Extensions. These examples come with readme files that explain how to install and get started with these widgets.
Expand Down
21 changes: 21 additions & 0 deletions developer-tools/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Contentstack

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
25 changes: 25 additions & 0 deletions developer-tools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Developer Tool – Contentstack Extension

#### About this extension
The “Developer Tools” extension provides developers with quick tools (API endpoint, JSON, etc.) to work with an entry or all entries of a content type and do a lot more.

The Developer Tools widget extension, which can be accessed on the right-hand side of the entry page, primarily has two tabs: API Details and JSON View.

#### 1. API Details:
This tab provides the REST API endpoints or queries (in any language of your choice) that you can readily use to access/fetch the current entry or all entries of the content type. You need to select the Platform, copy the endpoint/query, add the environment name, and use it as required to fetch the entry.

![Developer tool Screenshot](https://images.contentstack.io/v3/assets/blt23180bf2502c7444/blt041f961e0e0bc115/5dd76b0c13537f3bb9b5fdde/REST_API.PNG)

#### 2.JSON View:
The JSON view tab displays the JSON data of your entry. You can then copy this JSON and use it as per requirement or import it to other content types.

![Developer tool Screenshot](https://images.contentstack.io/v3/assets/blt23180bf2502c7444/blt7aeb9930bafd4f56/5dd76ad93667ee3ad876bbef/JSON_view_2.PNG)

#### How to use this extension
Developer tool is available as a prebuilt template that you can use instantly. Login to your Contentstack account, add it into your stack, and start using it.

Learn how to [add a developer tool extension](https://www.contentstack.com/docs/developers/create-custom-widgets/developer-tools/classic/) to your stack.

#### Other Documentation
- [Extensions guide](https://www.contentstack.com/docs/guide/extensions)
- [Common questions about extensions](https://www.contentstack.com/docs/faqs#extensions)
Loading

0 comments on commit 6b8b705

Please sign in to comment.