Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion basics/authentication/firebaseauthprovider.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ All premium features currently use **One Time Payment** model and you can use th
Installing the library:

```bash
$ yarn add @adminjs/firebase-auth
yarn add @adminjs/firebase-auth
```

The license key should be provided via `FirebaseAuthProvider` constructor:
Expand Down
2 changes: 1 addition & 1 deletion basics/features/import-and-export.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ AdminJS offers a feature called "@adminjs/import-export" which solves this use c
To install add the package to your project.

```shell
$ yarn add @adminjs/import-export
yarn add @adminjs/import-export
```

Then add one line (`features`) to resource entry in AdminJS config.
Expand Down
18 changes: 9 additions & 9 deletions basics/features/leaflet-maps.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Leaflet feature (`@adminjs/leaflet`) integrates Leaflet ([https://leafletjs.
## Installation

```bash
$ yarn add @adminjs/leaflet # or: npm install @adminjs/leaflet
yarn add @adminjs/leaflet # or: npm install @adminjs/leaflet
```

## Usage
Expand Down Expand Up @@ -232,14 +232,14 @@ An example application can be found in [@adminjs/leaflet GitHub repository](http
### Installation

```bash
$ git clone https://github.com/SoftwareBrothers/adminjs-leaflet.git
$ cd adminjs-leaflet
$ yarn install
$ yarn build
$ cd example-app
$ yarn install
$ docker-compose up -d
$ yarn start
git clone https://github.com/SoftwareBrothers/adminjs-leaflet.git
cd adminjs-leaflet
yarn install
yarn build
cd example-app
yarn install
docker-compose up -d
yarn start
```

## Issues & Ideas
Expand Down
2 changes: 1 addition & 1 deletion basics/features/logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The logger's purpose is to keep track of selected resources (i.e. tables) Every
Installation is pretty simple. First we have to install `@adminjs/logger` package

```shell
$ yarn add @adminjs/logger
yarn add @adminjs/logger
```

We can use any database and any ORM package as described in **Adapters** section.
Expand Down
2 changes: 1 addition & 1 deletion basics/features/password.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The password feature can be utilized to hash a user's password when editing it's
Installation

```shell
$ yarn add @adminjs/passwords
yarn add @adminjs/passwords
```

Next step is to add feature option to user resource
Expand Down
2 changes: 1 addition & 1 deletion basics/features/relations.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ All premium features currently use **One Time Payment** model and you can use th
Installing the library:

```bash
$ yarn add @adminjs/relations
yarn add @adminjs/relations
```

The license key should be provided to `owningRelationSettingsFeature`:
Expand Down
2 changes: 1 addition & 1 deletion basics/features/upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ There is possibility to use different storage for files: 

To install the upload feature run:

<pre class="language-shell"><code class="lang-shell"><strong>$ yarn add @adminjs/upload
<pre class="language-shell"><code class="lang-shell"><strong>yarn add @adminjs/upload
</strong></code></pre>

The main concept of the upload feature is that it sends uploaded files to an external source. The database keeps the information about path and folder name where the file was stored.
Expand Down
6 changes: 3 additions & 3 deletions basics/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Themes are a new feature of AdminJS version 7 which introduces new UI customizat
### Installation

```bash
$ yarn add @adminjs/themes
yarn add @adminjs/themes
```

### Usage
Expand Down Expand Up @@ -178,8 +178,8 @@ const authenticate = (email, password) => {
### Commands

```bash
$ npx adminjs-themes generate <options>
$ npx adminjs-themes bundle <options>
npx adminjs-themes generate <options>
npx adminjs-themes bundle <options>
```

#### #generate
Expand Down
6 changes: 3 additions & 3 deletions deployment/creating-deploying-the-application-using-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before you will make installation and configuration steps make sure you met all
{% code overflow="wrap" %}

```bash
$ yarn global add @adminjs/cloud-cli
yarn global add @adminjs/cloud-cli
```

{% endcode %}
Expand Down Expand Up @@ -92,7 +92,7 @@ config string optional Path to your configuration file (rel
#### Usage

```bash
$ adminjs-cloud create --name=<string> --database=<string> --apiKey=<string> --apiSecret=<string>
adminjs-cloud create --name=<string> --database=<string> --apiKey=<string> --apiSecret=<string>
```
### #deploy

Expand All @@ -109,5 +109,5 @@ config string optional Path to your configuration file (rel
#### Usage

```bash
$ adminjs-cloud deploy --apiKey=<string> --apiSecret=<string> --config=[string]
adminjs-cloud deploy --apiKey=<string> --apiSecret=<string> --config=[string]
```
2 changes: 1 addition & 1 deletion installation/adapters/objection.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before you start connecting your Objection models to AdminJS, we strongly advise
You might need to install an additional library `ajv-formats`:

```bash
$ yarn add ajv-formats
yarn add ajv-formats
```

{% code title="base-model.ts" %}
Expand Down
32 changes: 16 additions & 16 deletions installation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,19 @@ AdonisJS (and Lucid) integration should be installed using Adonis CLI. Please re
**NPM:**

```bash
$ npm i -g @adminjs/cli
npm i -g @adminjs/cli
```

**Yarn:**

```bash
$ yarn global add @adminjs/cli
yarn global add @adminjs/cli
```

#### Usage

```bash
$ adminjs create
adminjs create
```

You may also set up your AdminJS application manually by following the rest of this documentation.
Expand All @@ -59,29 +59,29 @@ You may also set up your AdminJS application manually by following the rest of t
First of all, install the core package:

```bash
$ yarn add adminjs
yarn add adminjs
```

Next, install one of our plugins:

```bash
$ yarn add @adminjs/express # for Express server
$ yarn add @adminjs/nestjs # for Nest server
$ yarn add @adminjs/hapi # for Hapi server
$ yarn add @adminjs/koa # for Koa server
$ yarn add @adminjs/fastify # for Fastify server
yarn add @adminjs/express # for Express server
yarn add @adminjs/nestjs # for Nest server
yarn add @adminjs/hapi # for Hapi server
yarn add @adminjs/koa # for Koa server
yarn add @adminjs/fastify # for Fastify server
```

Finally, install an adapter:

```bash
$ yarn add @adminjs/typeorm # for TypeORM
$ yarn add @adminjs/sequelize # for Sequelize
$ yarn add @adminjs/mongoose # for Mongoose
$ yarn add @adminjs/prisma # for Prisma
$ yarn add @adminjs/mikroorm # for MikroORM
$ yarn add @adminjs/objection # for Objection
$ yarn add @adminjs/sql # for raw SQL, currently supports only Postgres
yarn add @adminjs/typeorm # for TypeORM
yarn add @adminjs/sequelize # for Sequelize
yarn add @adminjs/mongoose # for Mongoose
yarn add @adminjs/prisma # for Prisma
yarn add @adminjs/mikroorm # for MikroORM
yarn add @adminjs/objection # for Objection
yarn add @adminjs/sql # for raw SQL, currently supports only Postgres
```

### Setup
Expand Down
2 changes: 1 addition & 1 deletion installation/migration-guide-v7.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ As a workaround, you can follow the steps below to resolve the problem.

Install `@types/styled-components` as a `devDependency` in your project:

`$ yarn add -D @types/styled-components`
`yarn add -D @types/styled-components`

Create a custom `d.ts` file which extends `@adminjs/design-system/styled-components` - for example `./vendor-types/adminjs-styled-components.d.ts`:

Expand Down
16 changes: 8 additions & 8 deletions installation/plugins/adonis.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@ Below you will find a simplified list of steps required to set up your AdminJS p
First of all, create your AdonisJS app if you haven't got one yet:

```bash
$ npm init adonisjs@latest -- -K=slim
npm init adonisjs@latest -- -K=slim
```

Follow the steps from AdonisJS CLI to configure your application and once it's installed, navigate to the newly created directory.

```bash
$ cd <your_app_directory>
cd <your_app_directory>
```

AdminJS requires you to install and configure `@adonisjs/session` and `@adonisjs/lucid`

```bash
$ npm install @adonisjs/session @adonisjs/lucid
$ node ace configure @adonisjs/session
$ node ace configure @adonisjs/lucid
npm install @adonisjs/session @adonisjs/lucid
node ace configure @adonisjs/session
node ace configure @adonisjs/lucid
```

This will create a configuration file for `@adonisjs/session` in `config/session.ts`. The default configuration will allow you to sign into your admin panel in your development environment, but before you deploy to production, please see the [official documentation](https://docs.adonisjs.com/guides/session#session).
Expand All @@ -41,14 +41,14 @@ You should also configure Lucid in `config/database.ts`. Without this, you won't
You will also need to install the core package of AdminJS:

```bash
$ npm install adminjs
npm install adminjs
```

Finally, install `@adminjs/adonis` which will add AdminJS integration into your application.

```bash
$ npm install @adminjs/adonis
$ node ace configure @adminjs/adonis
npm install @adminjs/adonis
node ace configure @adminjs/adonis
```

Three new files should appear in your codebase.
Expand Down
12 changes: 6 additions & 6 deletions installation/plugins/express.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ coverY: 0
Make sure you have installed AdminJS packages described in [Getting started](../getting-started.md) article.

```bash
$ yarn add adminjs @adminjs/express
yarn add adminjs @adminjs/express
```
{% endhint %}

To setup AdminJS panel with Express.js you need to have `express` installed and required peer dependencies:

```bash
$ yarn add express tslib express-formidable express-session
yarn add express tslib express-formidable express-session
```

Afterwards, follow one of the examples below.
Expand Down Expand Up @@ -56,7 +56,7 @@ start()
Install Express types:

```bash
$ yarn add -D @types/express
yarn add -D @types/express
```

{% code title="app.ts" %}
Expand Down Expand Up @@ -100,7 +100,7 @@ To add authentication, you must use `AdminJSExpress.buildAuthenticatedRouter` in
Install additional dependencies:

```bash
$ yarn add connect-pg-simple
yarn add connect-pg-simple
```

{% code title="app.js" %}
Expand Down Expand Up @@ -182,8 +182,8 @@ If you plan to copy-paste this example, make sure you set the database connectio
Install additional dependencies:

```bash
$ yarn add connect-pg-simple
$ yarn add -D @types/connect-pg-simple @types/express-session @types/express
yarn add connect-pg-simple
yarn add -D @types/connect-pg-simple @types/express-session @types/express
```

{% code title="app.ts" %}
Expand Down
10 changes: 5 additions & 5 deletions installation/plugins/fastify.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ coverY: 0
Make sure you have installed AdminJS packages described in [Getting started](../getting-started.md) article.

```bash
$ yarn add adminjs @adminjs/fastify
yarn add adminjs @adminjs/fastify
```
{% endhint %}

To setup AdminJS panel with Fastify you need to have `fastify` installed and required peer dependencies:

```bash
$ yarn add fastify tslib
yarn add fastify tslib
```

Afterwards, follow one of the examples below.
Expand Down Expand Up @@ -105,7 +105,7 @@ To add authentication, you must use `AdminJSFastify.buildAuthenticatedRouter` in
Install additional dependencies:

```bash
$ yarn add @fastify/session connect-pg-simple
yarn add @fastify/session connect-pg-simple
```

{% code title="app.js" %}
Expand Down Expand Up @@ -193,8 +193,8 @@ If you plan to copy-paste this example, make sure you set the database connectio
Install additional dependencies:

```bash
$ yarn add @fastify/session connect-pg-simple
$ yarn add -D @types/connect-pg-simple
yarn add @fastify/session connect-pg-simple
yarn add -D @types/connect-pg-simple
```

{% code title="app.ts" %}
Expand Down
4 changes: 2 additions & 2 deletions installation/plugins/hapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ coverY: 0
Make sure you have installed AdminJS packages described in [Getting started](../getting-started.md) article.

```bash
$ yarn add adminjs @adminjs/hapi
yarn add adminjs @adminjs/hapi
```
{% endhint %}

To setup AdminJS panel with Hapi you need to have `@hapi/hapi` installed and required peer dependencies:

```bash
$ yarn add @hapi/hapi @hapi/boom @hapi/cookie @hapi/inert
yarn add @hapi/hapi @hapi/boom @hapi/cookie @hapi/inert
```

Afterwards, follow one of the examples below.
Expand Down
8 changes: 4 additions & 4 deletions installation/plugins/koa.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ coverY: 0
Make sure you have installed AdminJS packages described in [Getting started](../getting-started.md) article.

```bash
$ yarn add adminjs @adminjs/koa
yarn add adminjs @adminjs/koa
```
{% endhint %}

To setup AdminJS panel with Koa you need to have `koa` installed and required peer dependencies:

```bash
$ yarn add koa @koa/router koa2-formidable
yarn add koa @koa/router koa2-formidable
```

Afterwards, follow one of the examples below.
Expand Down Expand Up @@ -61,7 +61,7 @@ start()
Install additional dependencies:

```bash
$ yarn add -D @types/koa
yarn add -D @types/koa
```

{% code title="app.ts" %}
Expand Down Expand Up @@ -165,7 +165,7 @@ As you may have noticed, the `authenticate` function compares credentials you su
Install additional dependencies:

```bash
$ yarn add -D @types/koa
yarn add -D @types/koa
```

{% code title="app.ts" %}
Expand Down
Loading