Skip to content

Latest commit

 

History

History
80 lines (45 loc) · 2.95 KB

README.md

File metadata and controls

80 lines (45 loc) · 2.95 KB

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 of any domain on Cloudflare.

Setup

Fork and clone the repo or download the latest release.

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

alt text

Next, navigate to our App Creator and upload your project directory.

alt text

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 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 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 are added for the app.

Use the DNS field to configure Cloudflare DNS Records. 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

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 for examples and API usage.