improve ticket_background_app
Saif-Shines opened this issue · 0 comments
Saif-Shines commented
Maintainer's thoughts:
This issue is ideally for pure beginners learning to make PRs and get familiar with open source contributions. Involve yourself to explore how apps on Freshworks developer platform run. You may not end up develop apps for Freshworks but experience remains helpful where so ever you choose to build apps. Chrome Store? Web Apps? Atlassian apps? Using github CLI? Stripe CLI?
- Find sample code for
ticket_background_app
app in the repository and tell us(in comments) if you were able to find it under 30s. - (Optional) Add summary in JSDoc commenting standards and elaborate parameters if you understand the code.
- Lower case the contents inside the
screenshots
folder (andScreenshots
folder itself). If there's no screenshots just add it if it's a frontend app or else move on to next task. - Update the
README.md
file so that it follows the standard format. Don't worry about filling in all the details. Just give it a shot. - Update the
README.md
file of the same app so that images inside ofscreenshots
folder are displayed on the app README.md file. - If you find any
iparams_test_data.json
inside ofconfig/
directory. Delete it. - Re organise all the files and folders in following structure. Make sure the
html
,css
andjs
files have right references tosrc
s.
.
├── README.md A file for future self and friends to learn about app
├── app A folder to place files needed for app's frontend components
│ ├── index.html The Entry point for the user to use the app
│ ├── scripts JavaScript to handle frontend components business logic
│ │ └── app.js
│ ├── styles A folder to place all the styles for the app
│ │ ├── images A folder for all the images
│ │ │ └── icon.svg
│ │ └── styles.css
│ └── views A folder to place all the pages
│ └── modal.html
├── config A folder to place configuration pages
│ └── iparams.json A JSON oriented way to construct a configuration page
└── manifest.json A JSON file holding meta data for app to run on platform
- Install Freshworks CLI
- Rewrite UI elements using Crayons kit. For example, this app uses buttons built using css(either from script tag or css file). Why not make it simple with crayons?
- Locally run the app by getting a trial account for relevant Freshworks' product (Hint: See
manifest.json
). We will let you figure out how to do that by exploring the developer documentation. How much time did you take to figure out? 2 min? - Take a look at Interface API section of developer documentation
- Facing difficulties? Reference to this issue and create a topic in developer community