This is an example project for the fic2-playground of the FIcontent project. It contains some files for a very basic project that can be handled by the playground (think 'Hello, world').
If you follow these steps, you can prepare your enabler for the playground. The following needs have to be fulfilled to ensure that your enabler is compatible to the playground.
- create a GitHub repository or use an existing one
- there has to be some folder that contains your entire client site, production-ready code (for example a folder named "public_html")
- there has to be a file named "playground.json" in the root of your GitHub repository that contains the fields specified in playground.json
- the field "path" contains the path from your repositories root to the folder containing the client site code
- the field "file" contains the name of your client site starting-file in the folder that contains the client site code (likely "index.html")
- you should provide a config.json (see config.json) in your folder with client side code (typically called 'www' or 'html') that configures the client and its connection to your backend. If you haven't anything to configure, you can omit the file.
- tell us when you are ready by creating an issue or a pull request to this readme.
(Pro-tipp: you can create a pull request by simply clicking on README.md and chosing 'edit' in the top bar. By saving Github creates a pull request fo you then.)