github
/
nocodb
mirror of https://github.com/nocodb/nocodb
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

docs: default page changed 

Signed-off-by: Pranav C <61551451+pranavxc@users.noreply.github.com>
pull/350/head
Pranav C 3 years ago
parent
f80fea2361
commit
c471270a52
3 changed files with 98 additions and 98 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 76
      packages/noco-doc/content/en/index.md
  2. 84
      packages/noco-doc/content/en/install.md
  3. 36
      packages/noco-doc/content/en/introduction.md

76
packages/noco-doc/content/en/index.md
Unescape View File

@ -1,36 +1,84 @@
---
title: 'Introduction'
title: 'Setup and Usage'
description: 'Simple installation - takes about three minutes!'
position: 0
category: 'Getting started'
fullscreen: true
menuTitle: 'Introduction'
menuTitle: 'Install'
link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme=dark
---
## Architecture
## Simple installation - takes about three minutes!
<img src="architecture.png" style="background: white;border-radius:4px;padding :10px">
### 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>
<br>
<br>
## 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>
| Project Type | Metadata stored in | Data stored in |
|---------|-----------|--------|
| Create new project | NC_DB | NC_DB |
| Create new project with external DB | NC_DB | External database |
```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>
### Sample app
<code-sandbox :src="link"></code-sandbox>
# Sample Demos
### Docker deploying with one command
<youtube id="K-UEecQyiOk"></youtube>
### Using Npx
<youtube id="v6Nn75P1p7I"></youtube>
### Heroku Deployment
<youtube id="v6Nn75P1p7I"></youtube>
<br>
<br>
<br>
<br>

84
packages/noco-doc/content/en/install.md
Unescape View File

@ -1,84 +0,0 @@
---
title: 'Setup and Usage'
description: 'Simple installation - takes about three minutes!'
position: 1
category: 'Getting started'
fullscreen: true
menuTitle: 'Install'
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>
### Sample app
<code-sandbox :src="link"></code-sandbox>
# Sample Demos
### Docker deploying with one command
<youtube id="K-UEecQyiOk"></youtube>
### Using Npx
<youtube id="v6Nn75P1p7I"></youtube>
### Heroku Deployment
<youtube id="v6Nn75P1p7I"></youtube>

36
packages/noco-doc/content/en/introduction.md
Unescape View File

@ -0,0 +1,36 @@
---
title: 'Introduction'
description: 'Simple installation - takes about three minutes!'
position: 1
category: 'Getting started'
fullscreen: true
menuTitle: 'Introduction'
---
## Architecture
<img src="architecture.png" style="background: white;border-radius:4px;padding :10px">
<br>
<br>
| Project Type | Metadata stored in | Data stored in |
|---------|-----------|--------|
| Create new project | NC_DB | NC_DB |
| Create new project with external DB | NC_DB | External database |
<br>
<br>
<br>
<br>
Write Preview
Loading…
Cancel
Save