Simplified API user interface
Application was written in vanilla JavaScript with scss. Additionaly, gulp was used for translation, minification, uglification and building for production. To build application use 'npm run build'.
While developing use 'gulp watch' to translate js with babel and scss to css
App was developed using "Live Server" plugin for Visual Studio Code so no additional server was needed to run it in development. However a simple node server (server.js file) was added to help start the app in another environment. Just run `node server.js` and head to localhost:8080.
App uses a state object to contain vital data. Right now it has one service to render (as described in brief), but it should handle more if necessary without any changes in code.
In current state, app requires an html dom node with "servicesContainer" id, to render pieces of interface in it. Can be changed at will.
Service object structure should be preserved, but more services, possible methods and possible formats can be added.
service:
{
name: srting,
selectedMethod: srting,
selectedFormat: srting,
url: srting,
possibleMethods: array <'possibleMethod'>,
possibleFormats: array <'possibleFormat'>
}
possibleMethod:
{
alias: srting,
value: srting
}
possibleFormat:
{
alias: srting,
value: srting
}
Prism.js was used to prettify response text. It isn't necessery, but definitely looks cool
As for next steps in this app development.
- Hooking it in with real back-end is probably first thing (shouldn't cause any problems)
- UI could be better, didn't got time to polish it properly
- Tests should be added to check if it still works after changes