Skip to content

Commit

Permalink
Cleanup (#95)
Browse files Browse the repository at this point in the history
* Remove redundant Push Notifications doc

* Direct devs to public docs site

* Remove redundant manifest docs

latest available here https://developers.adalo.com/docs/configuration/manifest-json
  • Loading branch information
appleguy19 authored Aug 7, 2023
1 parent d5ba689 commit 20d4f39
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 317 deletions.
73 changes: 2 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,3 @@
# Adalo Docs
# Adalo Developer Docs

Documentation for creating Adalo libraries

## Creating Libraries

Libraries in Adalo are simply react native (and [react native web](https://github.com/necolas/react-native-web) packages, with a couple of additional additions.

### package.json

In `package.json` you need to add an additional section called `"adalo"` that will look something like this:

```js
{
"name": "my-package",
"version": "0.0.1",
"dependencies": { ... },
"adalo": {
"displayName": "My Package",
"components": [
{
// "name" must match the exported name from your module.
// i.e. if you `import { FirstComponent } from 'my-package'` then you would put:
"name": "FirstCompnent",

// "manifest" is the relative path to the manifest.json file, relative to package.json
"manifest": "./src/FirstComponent/manifest.json"
},
{
"name": "Second Component",
"manifest": "./src/SecondComponent/manifest.json"
}
]
}
}
```

### Component Manifests

`manifest.json` is a file that must accompany every exported component. You define which props will be available in the UI when using your component in Adalo.

See the [Component Manifest Documentation](https://github.com/AdaloHQ/docs/blob/main/libraries/Manifests.md) to learn what to put inside your manifest.json file.

## Testing Locally

In order to test your package locally, you need to add a package dependency to your project:

```
npm install --save @adalo/cli
```

or:

```
yarn add @adalo/cli
```

Then, to run the package locally, to make it accessible in Adalo, run:

```bash
adalo dev
```

or:

```bash
npx adalo dev
```

The first time you run this, you'll be asked to login using your Adalo account. This is in order to allow you to use the package in your account on Adalo.

After you've successfully logged in and run `npx proton dev` again, you can go to Adalo and click the Add Layer button and you should see your package available at the bottom of the list of components.
These docs are for creating components for the Adalo Marketplace. They are best viewed at https://developers.adalo.com.
204 changes: 0 additions & 204 deletions libraries/Manifests.md

This file was deleted.

42 changes: 0 additions & 42 deletions public-api/README.md

This file was deleted.

0 comments on commit 20d4f39

Please sign in to comment.