Skip to content

Creating a project with a POST request

Create new projects by POSTing the desired project data from a form. This method is useful when you don't or can't use our JavaScript SDK.

This page will guide you through the setup. You can also take a look at the demo project at the end.

Required Form Fields

project[title] = Project title
project[description] = Project description
project[files][FILE_PATH] = Contents of file, specify file path as key
project[files][ANOTHER_FILE_PATH] = Contents of file, specify file path as key
project[dependencies] = JSON string of dependencies field from package.json
project[template] = Can be one of: typescript, angular-cli, create-react-app, javascript


Binary files (such as archives or non-SVG images) are not supported for the dynamically created projects.

Example Payload

Below is an example HTML form that generates a project from the RxJS docs using the typescript template:

<html lang="en">

<form id="mainForm" method="post" action="" target="_self">
<input type="hidden" name="project[files][index.ts]" value="import { Observable } from 'rxjs/Observable';
import 'rxjs/add/observable/fromEvent';
import 'rxjs/add/operator/scan';

var button = document.querySelector('button');
Observable.fromEvent(button, 'click')
  .scan((count: number) => count + 1, 0)
  .subscribe(count => console.log(`Clicked ${count} times`));
<input type="hidden" name="project[files][index.html]" value="<button>Click Me</button>
<input type="hidden" name="project[description]" value="RxJS Example">
<input type="hidden" name="project[dependencies]" value="{&quot;rxjs&quot;:&quot;5.5.6&quot;}">
<input type="hidden" name="project[template]" value="typescript">
<input type="hidden" name="project[settings]" value="{&quot;compile&quot;:{&quot;clearConsole&quot;:false}}">