https://github.com/videsk/widget-cloudflare

Videsk widget integration for Cloudflare Apps
https://github.com/videsk/widget-cloudflare

Last synced: about 11 hours ago
JSON representation

Videsk widget integration for Cloudflare Apps

• Host: GitHub
• URL: https://github.com/videsk/widget-cloudflare
• Owner: videsk
• License: mit
• Created: 2020-09-16T16:38:54.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-16T16:41:24.000Z (over 4 years ago)
• Last Synced: 2024-11-12T03:35:56.031Z (2 months ago)
• Language: JavaScript
• Size: 1.93 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[build]: ./media/build.gif "Build create-cloudflare-app"

[upload]: ./media/upload.gif "Upload create-cloudflare-app"

# Create Cloudflare App

## Overview

This is a starter project for building a Cloudflare App with Babel (for the latest ES features), ESLint, and Prettier (for keeping things clean).

Download this app and replace our code any time you want to build an Cloudflare app.

## Features

#### Cloudflare DNS

Your Cloudflare App can configure the [DNS Records](https://api.cloudflare.com/#dns-records-for-a-zone-properties) of any domain on Cloudflare.

## Setup

Fork and clone the repo or download the [latest release](https://github.com/CloudflareApps/CreateCloudflareApp/releases/latest).

Install the dependencies with `yarn install` then build the project with `yarn build` (or `npm run build`).

![alt text][build]

Next, navigate to our [App Creator](https://www.cloudflare.com/apps/developer/app-creator) and upload your project directory.

![alt text][upload]

The App Creator will update automatically on file changes (Chrome only). Once you're done testing, press Create App to submit your app for moderation. Refer to our [Terms of Use](https://www.cloudflare.com/apps/developer/docs/resources/terms-of-use) for more information.

## Usage

- `yarn start` (or `npm start`) Sets up your dev environment and runs Webpack in watch mode.

- `yarn build` (or `npm run build`) Lints your project and compiles your JavaScript and CSS once for release.

### Other Interesting Scripts

- `dev:setup` Add other initialization scripts to your development pipeline here.

The project uses [yarn-run-all](https://www.npmjs.com/package/yarn-run-all) which makes it easy to run tasks in series or parallel using `yarn` or `npm`.

## Details

#### `install.json`

This is where all the [installer options](https://www.cloudflare.com/apps/developer/docs/install-json) are added for the app.

Use the DNS field to configure [Cloudflare DNS Records](https://api.cloudflare.com/#dns-records-for-a-zone-properties). If you don't want to configure DNS, just delete this field.

#### `src/index.js`

This is where the magic happens. Your app starts here.

#### `src/styles.css`

Write your app styles here.

#### `media/**`

Put your icons, tile images, and screenshots to be used in your Cloudflare Apps page here.

[Download media-templates.sketch](https://github.com/CloudflareApps/MediaTemplates/raw/master/media-templates.sketch)

#### `webpack.config.js`

Simple Webpack 4 config using Babel and CSS Loader. Please refrain from modifying the config to minify your built code.

### Troubleshooting

The Cloudflare [developer documentation](https://www.cloudflare.com/apps/developer/docs/getting-started) for examples and API usage.