diff --git a/packages/noco-docs/content/en/apis/graphql/gql-apis-generated.md b/packages/noco-docs/content/en/developer-resources/graphql-apis.md similarity index 99% rename from packages/noco-docs/content/en/apis/graphql/gql-apis-generated.md rename to packages/noco-docs/content/en/developer-resources/graphql-apis.md index 6945cfced0..8b9932433d 100644 --- a/packages/noco-docs/content/en/apis/graphql/gql-apis-generated.md +++ b/packages/noco-docs/content/en/developer-resources/graphql-apis.md @@ -1,7 +1,7 @@ --- title: 'GraphQL APIs' position: 2 -category: 'API' +category: 'Developer Resources' fullscreen: true menuTitle: 'GraphQL APIs' --- diff --git a/packages/noco-docs/content/en/apis/rest/rest-apis-generated.md b/packages/noco-docs/content/en/developer-resources/rest-apis.md similarity index 99% rename from packages/noco-docs/content/en/apis/rest/rest-apis-generated.md rename to packages/noco-docs/content/en/developer-resources/rest-apis.md index 64d1c54bce..1e133ba7ef 100644 --- a/packages/noco-docs/content/en/apis/rest/rest-apis-generated.md +++ b/packages/noco-docs/content/en/developer-resources/rest-apis.md @@ -1,7 +1,7 @@ --- title: 'REST APIs' position: 1 -category: 'API' +category: 'Developer Resources' fullscreen: true menuTitle: 'REST APIs' --- diff --git a/packages/noco-docs/content/en/index.md b/packages/noco-docs/content/en/index.md index a9d3c86e72..99411ec203 100644 --- a/packages/noco-docs/content/en/index.md +++ b/packages/noco-docs/content/en/index.md @@ -1,167 +1,53 @@ --- -title: 'Setup and Usage' -description: 'Simple installation - takes about three minutes!' +title: 'NocoDB Documentation' +description: 'NocoDB Documentation' position: 0 category: 'Getting started' fullscreen: true -menuTitle: 'Install' -link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme=dark +menuTitle: 'Introduction' --- +## Welcome! -## Simple installation - takes about three minutes! +NocoDB is an open source Airtable alternative. -### Prerequisites +NocoDB works by connecting to any relational database and transforming them into a smart spreadsheet interface! This allows you to build no-code applications collaboratively with teams. NocoDB currently works with MySQL, PostgreSQL, Microsoft SQL Server, SQLite, Amazon Aurora & MariaDB databases. -- __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 : - here - - +Also NocoDB's app store allows you to build business workflows on views with combination of Slack, Microsoft Teams, Discord, Twilio, Whatsapp, Email & any 3rd party APIs too. Plus NocoDB provides programmatic access to APIs so that you can build integrations with Zapier / Integromat and custom applications too. +## Features -## Quick try -### 1-Click Deploy - - Deploy NocoDB to Heroku with 1-Click - +### Rich Spreadsheet Interface +- ⚡  Search, sort, filter, hide columns with uber ease +- ⚡  Create Views : Grid, Gallery, Kanban, Gantt, Form +- ⚡  Share Views : public & password protected +- ⚡  Personal & locked Views +- ⚡  Upload images to cells (Works with S3, Minio, GCP, Azure, DigitalOcean, Linode, OVH, BackBlaze)!! +- ⚡  Roles : Owner, Creator, Editor, Commenter, Viewer, Commenter, Custom Roles. +- ⚡  Access Control : Fine-grained access control even at database, table & column level. -### Node app or docker +### App Store for workflow automations : +- ⚡  Chat : Microsoft Teams, Slack, Discord, Mattermost +- ⚡  Email : SMTP, SES, Mailchimp +- ⚡  SMS : Twilio +- ⚡  Whatsapp +- ⚡  Any 3rd Party APIs +### Programmatic API access via : +- ⚡  REST APIs (Swagger) +- ⚡  GraphQL APIs. +- ⚡  Includes JWT Authentication & Social Auth +- ⚡  API tokens to integrate with Zapier, Integromat. - - - - ```bash - npx create-nocodb-app - ``` - - - - - ```bash - docker run -d --name nocodb -p 8080:8080 nocodb/nocodb - ``` - - - - - ```bash -git clone https://github.com/nocodb/nocodb-seed -cd nocodb-seed -npm install -npm start - ``` - - - +## Architecture +

-# 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 - - - - -```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 -``` - - - -```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 -``` - - - - -```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 -``` - - - -## Docker Compose - - - - - -```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 -``` - - - - -```shell script -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 - - - -### Heroku Deployment - - +| 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 | \ No newline at end of file diff --git a/packages/noco-docs/content/en/introduction.md b/packages/noco-docs/content/en/introduction.md deleted file mode 100644 index 38fb7b8b19..0000000000 --- a/packages/noco-docs/content/en/introduction.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: 'Introduction' -description: 'Simple installation - takes about three minutes!' -position: 1 -category: 'Getting started' -fullscreen: true -menuTitle: 'Introduction' ---- - - -## Architecture - - - - - - -
-
- - - - -| 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 | - - - - - -
-
-
-
\ No newline at end of file diff --git a/packages/noco-docs/content/en/demos.md b/packages/noco-docs/content/en/setup-and-usages/demos.md similarity index 59% rename from packages/noco-docs/content/en/demos.md rename to packages/noco-docs/content/en/setup-and-usages/demos.md index 813bf3a27d..e753540c0a 100644 --- a/packages/noco-docs/content/en/demos.md +++ b/packages/noco-docs/content/en/setup-and-usages/demos.md @@ -1,11 +1,10 @@ --- -title: 'Demos' +title: 'Demostrations' +description: 'Demos' position: 2 -category: 'Demos' +category: 'Setup and Usages' fullscreen: true menuTitle: 'Demos' --- -[Demos](https://nocodb.com/demos) -