freshworks / marketplace-sample-apps

Repository of sample codes demonstrating usage of SDK and APIs on the Freshworks developer platform. :link: https://developers.freshworks.com
124 stars 270 forks source link

[Enhancement] - Individual sample app README format #103

Closed hemchander23 closed 4 years ago

hemchander23 commented 5 years ago

Description of the enhancement: The idea is to have a consistent README for developers who land on sample apps repo. Would require suggestions from all. I have added the format in the issue below

For which Freshworks product?

hemchander23 commented 5 years ago

[Sample App Title]

Description:

[Description of the sample app]

Features used:

Prerequisites:

  1. Make sure you have a trial [FreshworksProduct] account created
  2. Ensure that you have the Freshworks Developer Kit (FDK) installed properly.

[From point 3, add some of the important prerequisites which are specific to this app]

Procedure to run the app:

  1. Fill the iparam_test_data.json before running the app locally.
  2. Run the app locally using the fdk run command
  3. Append ?dev=true to the Freshworks product URL to see the changes

[ Special instructions for realizing the value out of this app]

Screenshots:

[Screenshots that are not too big/small. Gifs are best. Let's just stick to 3 screenshots at the max]

Feel free to contribute / raise issues


velmurugan-balasubramanian commented 5 years ago

will this order make sense ?

  1. Description
  2. Prerequisites
  3. Procedure to run the app with step by step screenshots/GIFS instead of having it in the beginning
  4. GIF of working version of the app.
hemchander23 commented 5 years ago

Would go with this order as well. Will also add features used in the app (data storage/ request / ..)

Saif-Shines commented 5 years ago

@hemchander23 Can we add this template to Contribuiting guidelines as well ?

hemchander23 commented 5 years ago

Yes Saif

Saif-Shines commented 4 years ago

Closing this issue as PR Issue template is created inspired by this work.