mirror of https://github.com/nocodb/nocodb
Wing-Kam Wong
3 years ago
2 changed files with 172 additions and 0 deletions
@ -0,0 +1,10 @@
|
||||
--- |
||||
title: 'Demostrations' |
||||
description: 'Demos' |
||||
position: 2 |
||||
category: 'Setup and Usages' |
||||
fullscreen: true |
||||
menuTitle: 'Demos' |
||||
--- |
||||
|
||||
<iframe src="https://nocodb.com/demos" style="height:100vh" width="100%"/> |
@ -0,0 +1,162 @@
|
||||
--- |
||||
title: 'Setup and Usages' |
||||
description: 'Simple installation - takes about three minutes!' |
||||
position: 1 |
||||
category: 'Setup and Usages' |
||||
fullscreen: true |
||||
menuTitle: 'Installation' |
||||
link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme=dark |
||||
--- |
||||
|
||||
## Simple installation - takes about three minutes! |
||||
|
||||
### Prerequisites |
||||
|
||||
- __Must haves__ |
||||
* [node.js >= 12](https://nodejs.org/en/download) / [Docker](https://www.docker.com/get-started) |
||||
* [MySql](https://dev.mysql.com/downloads/mysql/) / [Postgres](https://www.postgresql.org/download/) / [SQLserver](https://www.microsoft.com/en-gb/sql-server/sql-server-downloads) / SQLite Database |
||||
- Nice to haves |
||||
- Existing schemas can help to create APIs quickly. |
||||
- An example database schema can be found : <a class="grey--text" href="https://github.com/lerocha/chinook-database/tree/master/ChinookDatabase/DataSources"> <u>here</u> </a> |
||||
|
||||
## Quick try |
||||
### 1-Click Deploy |
||||
<a href="https://heroku.com/deploy?template=https://github.com/npgia/nocodb-seed-heroku"> |
||||
<img |
||||
src="https://www.herokucdn.com/deploy/button.svg" |
||||
width="300px" |
||||
alt="Deploy NocoDB to Heroku with 1-Click" |
||||
/> |
||||
</a> |
||||
|
||||
### Node app or docker |
||||
|
||||
|
||||
<code-group> |
||||
<code-block label="NPX" active> |
||||
|
||||
```bash |
||||
npx create-nocodb-app |
||||
``` |
||||
|
||||
</code-block> |
||||
|
||||
<code-block label="Docker" > |
||||
|
||||
```bash |
||||
docker run -d --name nocodb -p 8080:8080 nocodb/nocodb |
||||
``` |
||||
|
||||
</code-block> |
||||
|
||||
<code-block label="Using Git" > |
||||
|
||||
```bash |
||||
git clone https://github.com/nocodb/nocodb-seed |
||||
cd nocodb-seed |
||||
npm install |
||||
npm start |
||||
``` |
||||
|
||||
</code-block> |
||||
</code-group> |
||||
|
||||
|
||||
|
||||
<br> |
||||
<br> |
||||
|
||||
# Production Setup |
||||
NocoDB requires a database to store metadata of spreadsheets views and external databases. |
||||
And connection params for this database can be specified in `NC_DB` environment variable. |
||||
|
||||
|
||||
## Docker |
||||
|
||||
<code-group> |
||||
<code-block label="MySQL" active> |
||||
|
||||
```bash |
||||
docker run -d -p 8080:8080 \ |
||||
-e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ |
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ |
||||
nocodb/nocodb |
||||
``` |
||||
|
||||
</code-block> |
||||
|
||||
<code-block label="Postgres"> |
||||
|
||||
```bash |
||||
docker run -d -p 8080:8080 \ |
||||
-e NC_DB="pg://host:port?u=user&p=password&d=database" \ |
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ |
||||
nocodb/nocodb |
||||
``` |
||||
|
||||
</code-block> |
||||
|
||||
<code-block label="SQL Server"> |
||||
|
||||
```bash |
||||
docker run -d -p 8080:8080 \ |
||||
-e NC_DB="mssql://host:port?u=user&p=password&d=database" \ |
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ |
||||
nocodb/nocodb |
||||
``` |
||||
|
||||
</code-block> |
||||
</code-group> |
||||
|
||||
## Docker Compose |
||||
|
||||
<code-group> |
||||
<code-block label="MySQL" active> |
||||
|
||||
```bash |
||||
git clone https://github.com/nocodb/nocodb |
||||
cd docker-compose |
||||
cd mysql |
||||
docker-compose up |
||||
``` |
||||
|
||||
</code-block> |
||||
|
||||
<code-block label="Postgres"> |
||||
|
||||
```bash |
||||
git clone https://github.com/nocodb/nocodb |
||||
cd docker-compose |
||||
cd pg |
||||
docker-compose up |
||||
``` |
||||
|
||||
</code-block> |
||||
|
||||
<code-block label="SQL Server"> |
||||
|
||||
```bash |
||||
git clone https://github.com/nocodb/nocodb |
||||
cd docker-compose |
||||
cd mssql |
||||
docker-compose up |
||||
``` |
||||
|
||||
</code-block> |
||||
</code-group> |
||||
|
||||
### Sample app |
||||
<code-sandbox :src="link"></code-sandbox> |
||||
|
||||
## Sample Demostrations |
||||
|
||||
### Docker deploying with one command |
||||
|
||||
<youtube id="K-UEecQyiOk"></youtube> |
||||
|
||||
### Using NPX |
||||
|
||||
<youtube id="v6Nn75P1p7I"></youtube> |
||||
|
||||
### Heroku Deployment |
||||
<youtube id="v6Nn75P1p7I"></youtube> |
Loading…
Reference in new issue