@ -0,0 +1,40 @@ |
|||||||
|
name: Publish Blog |
||||||
|
|
||||||
|
on: |
||||||
|
push: |
||||||
|
branches: [ master ] |
||||||
|
|
||||||
|
jobs: |
||||||
|
copy-file: |
||||||
|
runs-on: ubuntu-latest |
||||||
|
steps: |
||||||
|
- name: Checkout |
||||||
|
uses: actions/checkout@v2 |
||||||
|
- name: Check for change |
||||||
|
run: | |
||||||
|
echo "CHANGED=$([[ $(git log --pretty=format:'%h' -n 1 --skip 1 | xargs lerna ls --since | grep noco-blog) = noco-blog ]] && echo 'OK')" >> $GITHUB_ENV |
||||||
|
|
||||||
|
- uses: actions/setup-node@v2 |
||||||
|
if: ${{ env.CHANGED == 'OK' }} |
||||||
|
with: |
||||||
|
node-version: 14 |
||||||
|
- name: Build docs |
||||||
|
if: ${{ env.CHANGED == 'OK' }} |
||||||
|
run: | |
||||||
|
cd packages/noco-doc |
||||||
|
npm install |
||||||
|
npm run generate |
||||||
|
|
||||||
|
|
||||||
|
- name: Pushes generated output |
||||||
|
if: ${{ env.CHANGED == 'OK' }} |
||||||
|
uses: dmnemec/copy_file_to_another_repo_action@main |
||||||
|
env: |
||||||
|
API_TOKEN_GITHUB: ${{ secrets.GH_TOKEN }} |
||||||
|
with: |
||||||
|
source_file: 'packages/noco-blog/dist/' |
||||||
|
destination_repo: 'nocodb/noco-blog' |
||||||
|
destination_folder: 'docs' |
||||||
|
user_email: 'pranavxc@gmail.com' |
||||||
|
user_name: 'pranavxc' |
||||||
|
commit_message: 'Autorelease from github.com/nocodb/nocodb/packages/noco-blog' |
@ -0,0 +1,40 @@ |
|||||||
|
name: Publish Book |
||||||
|
|
||||||
|
on: |
||||||
|
push: |
||||||
|
branches: [ master ] |
||||||
|
|
||||||
|
jobs: |
||||||
|
copy-file: |
||||||
|
runs-on: ubuntu-latest |
||||||
|
steps: |
||||||
|
- name: Checkout |
||||||
|
uses: actions/checkout@v2 |
||||||
|
- name: Check for change |
||||||
|
run: | |
||||||
|
echo "CHANGED=$([[ $(git log --pretty=format:'%h' -n 1 --skip 1 | xargs lerna ls --since | grep noco-book) = noco-book ]] && echo 'OK')" >> $GITHUB_ENV |
||||||
|
|
||||||
|
- uses: actions/setup-node@v2 |
||||||
|
if: ${{ env.CHANGED == 'OK' }} |
||||||
|
with: |
||||||
|
node-version: 14 |
||||||
|
- name: Build docs |
||||||
|
if: ${{ env.CHANGED == 'OK' }} |
||||||
|
run: | |
||||||
|
cd packages/noco-doc |
||||||
|
npm install |
||||||
|
npm run generate |
||||||
|
|
||||||
|
|
||||||
|
- name: Pushes generated output |
||||||
|
if: ${{ env.CHANGED == 'OK' }} |
||||||
|
uses: dmnemec/copy_file_to_another_repo_action@main |
||||||
|
env: |
||||||
|
API_TOKEN_GITHUB: ${{ secrets.GH_TOKEN }} |
||||||
|
with: |
||||||
|
source_file: 'packages/noco-book/dist/' |
||||||
|
destination_repo: 'nocodb/noco-book' |
||||||
|
destination_folder: 'docs' |
||||||
|
user_email: 'pranavxc@gmail.com' |
||||||
|
user_name: 'pranavxc' |
||||||
|
commit_message: 'Autorelease from github.com/nocodb/nocodb/packages/noco-book' |
@ -1,7 +1,6 @@ |
|||||||
{ |
{ |
||||||
"name": "nc-doc-md-theme", |
"name": "noco-blog", |
||||||
"version": "1.0.0", |
"version": "1.0.0", |
||||||
"private": true, |
|
||||||
"scripts": { |
"scripts": { |
||||||
"dev": "nuxt", |
"dev": "nuxt", |
||||||
"build": "nuxt build", |
"build": "nuxt build", |
Before Width: | Height: | Size: 6.3 KiB After Width: | Height: | Size: 6.3 KiB |
Before Width: | Height: | Size: 982 B After Width: | Height: | Size: 982 B |
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.7 KiB |
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 3.2 KiB |
@ -0,0 +1,11 @@ |
|||||||
|
node_modules |
||||||
|
*.iml |
||||||
|
.idea |
||||||
|
*.log* |
||||||
|
.nuxt |
||||||
|
.vscode |
||||||
|
.DS_Store |
||||||
|
coverage |
||||||
|
dist |
||||||
|
sw.* |
||||||
|
.env |
@ -0,0 +1,11 @@ |
|||||||
|
# `noco-doc` |
||||||
|
|
||||||
|
> TODO: description |
||||||
|
|
||||||
|
## Usage |
||||||
|
|
||||||
|
``` |
||||||
|
const nocoDoc = require('noco-doc'); |
||||||
|
|
||||||
|
// TODO: DEMONSTRATE API |
||||||
|
``` |
@ -0,0 +1,7 @@ |
|||||||
|
main.container{ |
||||||
|
max-width:100% !important; |
||||||
|
} |
||||||
|
|
||||||
|
footer a[href="https://nuxtjs.org"]{ |
||||||
|
display: none; |
||||||
|
} |
@ -0,0 +1,33 @@ |
|||||||
|
<template> |
||||||
|
<div> |
||||||
|
<iframe type="text/html" width="100%" style="height:100%" |
||||||
|
:src="`https://www.youtube.com/embed/${id}`" |
||||||
|
frameborder="0" allowfullscreen></iframe> |
||||||
|
</div> |
||||||
|
</template> |
||||||
|
|
||||||
|
<script> |
||||||
|
export default { |
||||||
|
name: "youtube", |
||||||
|
props: { |
||||||
|
id: String |
||||||
|
} |
||||||
|
} |
||||||
|
</script> |
||||||
|
|
||||||
|
<style scoped> |
||||||
|
div { |
||||||
|
background-color: red; |
||||||
|
width: 100%; |
||||||
|
padding-top: min(500px,56%); |
||||||
|
position: relative; |
||||||
|
} |
||||||
|
|
||||||
|
iframe { |
||||||
|
position: absolute; |
||||||
|
top: 0; |
||||||
|
left: 0; |
||||||
|
bottom: 0; |
||||||
|
right: 0; |
||||||
|
} |
||||||
|
</style> |
@ -0,0 +1,84 @@ |
|||||||
|
--- |
||||||
|
title: 'Setup and Usage' |
||||||
|
description: 'Simple installation - takes about three minutes!' |
||||||
|
position: 0 |
||||||
|
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> |
||||||
|
|
@ -0,0 +1,11 @@ |
|||||||
|
{ |
||||||
|
"title": "NocoDB", |
||||||
|
"url": "https://nocodb.com", |
||||||
|
"logo": { |
||||||
|
"light": "/favicon-128.png", |
||||||
|
"dark": "/favicon-128.png" |
||||||
|
}, |
||||||
|
"github": "nocodb/nocodb", |
||||||
|
"defaultDir": "packages/noco-book", |
||||||
|
"twitter": "@nocodb" |
||||||
|
} |
@ -0,0 +1,12 @@ |
|||||||
|
import theme from '@nuxt/content-theme-docs' |
||||||
|
|
||||||
|
export default theme({ |
||||||
|
docs: { |
||||||
|
primaryColor: '#3282ff' |
||||||
|
}, |
||||||
|
css: [ |
||||||
|
"./assets/main.css" |
||||||
|
], content: { |
||||||
|
liveEdit: false |
||||||
|
} |
||||||
|
}) |
@ -0,0 +1,14 @@ |
|||||||
|
{ |
||||||
|
"name": "noco-book", |
||||||
|
"version": "1.0.0", |
||||||
|
"scripts": { |
||||||
|
"dev": "nuxt", |
||||||
|
"build": "nuxt build", |
||||||
|
"start": "nuxt start", |
||||||
|
"generate": "nuxt generate" |
||||||
|
}, |
||||||
|
"dependencies": { |
||||||
|
"@nuxt/content-theme-docs": "0.7.2", |
||||||
|
"nuxt": "^2.15.2" |
||||||
|
} |
||||||
|
} |
After Width: | Height: | Size: 6.3 KiB |
After Width: | Height: | Size: 982 B |
After Width: | Height: | Size: 1.7 KiB |
After Width: | Height: | Size: 3.2 KiB |
@ -0,0 +1,11 @@ |
|||||||
|
node_modules |
||||||
|
*.iml |
||||||
|
.idea |
||||||
|
*.log* |
||||||
|
.nuxt |
||||||
|
.vscode |
||||||
|
.DS_Store |
||||||
|
coverage |
||||||
|
dist |
||||||
|
sw.* |
||||||
|
.env |
@ -0,0 +1,11 @@ |
|||||||
|
# `noco-doc` |
||||||
|
|
||||||
|
> TODO: description |
||||||
|
|
||||||
|
## Usage |
||||||
|
|
||||||
|
``` |
||||||
|
const nocoDoc = require('noco-doc'); |
||||||
|
|
||||||
|
// TODO: DEMONSTRATE API |
||||||
|
``` |
@ -0,0 +1,7 @@ |
|||||||
|
main.container{ |
||||||
|
max-width:100% !important; |
||||||
|
} |
||||||
|
|
||||||
|
footer a[href="https://nuxtjs.org"]{ |
||||||
|
display: none; |
||||||
|
} |
@ -0,0 +1,33 @@ |
|||||||
|
<template> |
||||||
|
<div> |
||||||
|
<iframe type="text/html" width="100%" style="height:100%" |
||||||
|
:src="`https://www.youtube.com/embed/${id}`" |
||||||
|
frameborder="0" allowfullscreen></iframe> |
||||||
|
</div> |
||||||
|
</template> |
||||||
|
|
||||||
|
<script> |
||||||
|
export default { |
||||||
|
name: "youtube", |
||||||
|
props: { |
||||||
|
id: String |
||||||
|
} |
||||||
|
} |
||||||
|
</script> |
||||||
|
|
||||||
|
<style scoped> |
||||||
|
div { |
||||||
|
background-color: red; |
||||||
|
width: 100%; |
||||||
|
padding-top: min(500px,56%); |
||||||
|
position: relative; |
||||||
|
} |
||||||
|
|
||||||
|
iframe { |
||||||
|
position: absolute; |
||||||
|
top: 0; |
||||||
|
left: 0; |
||||||
|
bottom: 0; |
||||||
|
right: 0; |
||||||
|
} |
||||||
|
</style> |
@ -0,0 +1,84 @@ |
|||||||
|
--- |
||||||
|
title: 'Setup and Usage' |
||||||
|
description: 'Simple installation - takes about three minutes!' |
||||||
|
position: 0 |
||||||
|
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> |
||||||
|
|
@ -0,0 +1,11 @@ |
|||||||
|
{ |
||||||
|
"title": "NocoDB", |
||||||
|
"url": "https://nocodb.com", |
||||||
|
"logo": { |
||||||
|
"light": "/favicon-128.png", |
||||||
|
"dark": "/favicon-128.png" |
||||||
|
}, |
||||||
|
"github": "nocodb/nocodb", |
||||||
|
"defaultDir": "packages/noco-docs", |
||||||
|
"twitter": "@nocodb" |
||||||
|
} |
@ -0,0 +1,12 @@ |
|||||||
|
import theme from '@nuxt/content-theme-docs' |
||||||
|
|
||||||
|
export default theme({ |
||||||
|
docs: { |
||||||
|
primaryColor: '#3282ff' |
||||||
|
}, |
||||||
|
css: [ |
||||||
|
"./assets/main.css" |
||||||
|
], content: { |
||||||
|
liveEdit: false |
||||||
|
} |
||||||
|
}) |
@ -0,0 +1,14 @@ |
|||||||
|
{ |
||||||
|
"name": "noco-docs", |
||||||
|
"version": "1.0.0", |
||||||
|
"scripts": { |
||||||
|
"dev": "nuxt", |
||||||
|
"build": "nuxt build", |
||||||
|
"start": "nuxt start", |
||||||
|
"generate": "nuxt generate" |
||||||
|
}, |
||||||
|
"dependencies": { |
||||||
|
"@nuxt/content-theme-docs": "0.7.2", |
||||||
|
"nuxt": "^2.15.2" |
||||||
|
} |
||||||
|
} |
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 8.8 KiB |
After Width: | Height: | Size: 6.3 KiB |
After Width: | Height: | Size: 982 B |
After Width: | Height: | Size: 1.7 KiB |
After Width: | Height: | Size: 3.2 KiB |