diff --git a/packages/noco-docs/content/en/index.md b/packages/noco-docs/content/en/index.md index a9d3c86e72..c83d7e1f93 100644 --- a/packages/noco-docs/content/en/index.md +++ b/packages/noco-docs/content/en/index.md @@ -4,11 +4,10 @@ description: 'Simple installation - takes about three minutes!' position: 0 category: 'Getting started' fullscreen: true -menuTitle: 'Install' +menuTitle: 'Installation' link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme=dark --- - ## Simple installation - takes about three minutes! ### Prerequisites @@ -18,13 +17,8 @@ link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme * [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 : - here - + - An example database schema can be found : here - - ## Quick try ### 1-Click Deploy @@ -46,6 +40,7 @@ link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme ``` + ```bash @@ -53,13 +48,14 @@ link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme ``` + ```bash -git clone https://github.com/nocodb/nocodb-seed -cd nocodb-seed -npm install -npm start + git clone https://github.com/nocodb/nocodb-seed + cd nocodb-seed + npm install + npm start ``` @@ -78,90 +74,88 @@ And connection params for this database can be specified in `NC_DB` environment ## Docker - + -```shell script -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 -``` + ```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 + ``` + - -```shell script -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 -``` + + + ```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 + ``` - - -```shell script -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 -``` + + + + ```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 + ``` + ## Docker Compose - + + ```bash + git clone https://github.com/nocodb/nocodb + cd docker-compose + cd mysql + docker-compose up + ``` + + -```shell script -git clone https://github.com/nocodb/nocodb -cd docker-compose -cd mysql -docker-compose up -``` - -```shell script -git clone https://github.com/nocodb/nocodb -cd docker-compose -cd pg -docker-compose up -``` + ```bash + git clone https://github.com/nocodb/nocodb + cd docker-compose + cd pg + docker-compose up + ``` - - + -```shell script -git clone https://github.com/nocodb/nocodb -cd docker-compose -cd mssql -docker-compose up -``` - - - - + + ```bash + git clone https://github.com/nocodb/nocodb + cd docker-compose + cd mssql + docker-compose up + ``` + + - - - ### Sample app - # Sample Demos ### Docker deploying with one command -### Using Npx +### Using NPX ### Heroku Deployment - - + \ No newline at end of file