docs: add TOC, remove duplicate info and modify wordings

Signed-off-by: Wing-Kam Wong <wingkwong.code@gmail.com>
3 years ago · f708c769e7
1 changed files with 65 additions and 28 deletions
--- a/README.md
+++ b/README.md
@ -28,6 +28,10 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadshe

 <p align="center"><img src="https://user-images.githubusercontent.com/5435402/133762127-e94da292-a1c3-4458-b09a-02cd5b57be53.png" alt="The Open Source Airtable Alternative - works on MySQL, Postgres SQL Server & MariaDB" width="1000px" /></p>

+<p align="center">
+  <a href="https://www.producthunt.com/posts/nocodb?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-nocodb" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=297536&theme=dark" alt="NocoDB - The Open Source Airtable alternative | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
+</p>
+
 <div align="center">

 [<img height="38" src="https://user-images.githubusercontent.com/61551451/135263434-75fe793d-42af-49e4-b964-d70920e41655.png">](scripts/markdown/readme/languages/chinese.md)
@ -46,9 +50,40 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadshe

 <img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" />

-
-<a href="https://www.producthunt.com/posts/nocodb?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-nocodb" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=297536&theme=dark" alt="NocoDB - The Open Source Airtable alternative | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
-
+# Table of Contents
+
+- [Quick try](#quick-try)
+    + [1-Click Deploy](#1-click-deploy)
+      - [Heroku](#heroku)
+    + [Using Docker](#using-docker)
+    + [Using Npm](#using-npm)
+    + [Using Git](#using-git)
+    + [GUI](#gui)
+- [Screenshots](#screenshots)
+- [Features](#features)
+    + [Rich Spreadsheet Interface](#rich-spreadsheet-interface)
+    + [App Store for workflow automations](#app-store-for-workflow-automations)
+    + [Programmatic API access via](#programmatic-api-access-via)
+- [Production Setup](#production-setup)
+  * [Docker](#docker)
+      - [Example: MySQL](#example--mysql)
+      - [Example: PostgreSQL](#example--postgresql)
+      - [Example: SQL Server](#example--sql-server)
+  * [Docker Compose](#docker-compose)
+  * [Environment variables](#environment-variables)
+- [Development Setup](#development-setup)
+  * [Cloning the project](#clone-the-project)
+  * [Running Backend locally](#running-backend-locally)
+  * [Running Frontend locally](#running-frontend-locally)
+  * [Running Cypress tests locally](#running-cypress-tests-locally)
+- [Contributing](#contributing)
+- [Why are we building this?](#---why-are-we-building-this-)
+- [Our Mission](#--our-mission--)
+- [Contributors](#contributors-------------)
+
+
+
+---

 # Quick try
 ### 1-Click Deploy
@ -67,16 +102,19 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadshe
 ```bash
 docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest
 ```
-<br>

- NocoDB needs a database as input : [Click here for production setup](https://github.com/nocodb/nocodb/blob/master/README.md#production-setup).
- If this input is absent we fallback to SQLite - to persist sqlite you can mount `/usr/app/data/`. Example below
-  - ```docker run -d -p 8080:8080 --name nocodb -v /local/path:/usr/app/data/ nocodb/nocodb:latest```
+- NocoDB needs a database as input : See [Production Setup](https://github.com/nocodb/nocodb/blob/master/README.md#production-setup).
+- If this input is absent, we fallback to SQLite. In order too persist sqlite, you can mount `/usr/app/data/`. 
+
+  Example:
+
+  ```docker run -d -p 8080:8080 --name nocodb -v /local/path:/usr/app/data/ nocodb/nocodb:latest```

 ### Using Npm
 ```
 npx create-nocodb-app
 ```
+
 ### Using Git
 ```
 git clone https://github.com/nocodb/nocodb-seed
@ -88,13 +126,6 @@ npm start
 ### GUI
 Access Dashboard using : [http://localhost:8080/dashboard](http://localhost:8080/dashboard)

-
-# Join Our Community
-<a href="https://discord.gg/5RgZmkW">
-<img src="https://discordapp.com/api/guilds/661905455894888490/widget.png?style=banner3" alt="">
-</a>
-<br>
-
 # Screenshots

 ![2](https://user-images.githubusercontent.com/5435402/133759229-4275b934-873b-4a9b-9f23-96470fec9775.png)
@ -140,14 +171,14 @@ Access Dashboard using : [http://localhost:8080/dashboard](http://localhost:8080
 - ⚡ &nbsp;Roles : Owner, Creator, Editor, Viewer, Commenter, Custom Roles.
 - ⚡ &nbsp;Access Control : Fine-grained access control even at database, table & column level.

-### App Store for workflow automations :
+### App Store for workflow automations
 - ⚡ &nbsp;Chat : Microsoft Teams, Slack, Discord, Mattermost
 - ⚡ &nbsp;Email : SMTP, SES, Mailchimp
 - ⚡ &nbsp;SMS : Twilio
 - ⚡ &nbsp;Whatsapp
 - ⚡ &nbsp;Any 3rd Party APIs

-### Programmatic API access via :
+### Programmatic API access via
 - ⚡ &nbsp;REST APIs (Swagger) 
 - ⚡ &nbsp;GraphQL APIs.
 - ⚡ &nbsp;Includes JWT Authentication & Social Auth
@ -159,7 +190,7 @@ And connection params for this database can be specified in `NC_DB` environment

 ## Docker 

-#### Example MySQL
+#### Example: MySQL
 ```
 docker run -d -p 8080:8080 \
    -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \
@ -167,7 +198,7 @@ docker run -d -p 8080:8080 \
    nocodb/nocodb:latest
 ```

-#### Example PostgreSQL
+#### Example: PostgreSQL
 ```
 docker run -d -p 8080:8080 \
    -e NC_DB="pg://host:port?u=user&p=password&d=database" \
@ -175,7 +206,7 @@ docker run -d -p 8080:8080 \
    nocodb/nocodb:latest
 ```

-#### Example SQL Server
+#### Example: SQL Server
 ```
 docker run -d -p 8080:8080 \
    -e NC_DB="mssql://host:port?u=user&p=password&d=database" \
@ -196,23 +227,29 @@ docker-compose up

 Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables)

-# Development setup 
+# Development Setup 
+
+## Cloning the Project
+
 ```shell
 git clone https://github.com/nocodb/nocodb
-cd nocodb
+```
+
+## Running Backend locally

-# run backend
-cd packages/nocodb
+```shell
+cd nocodb/packages/nocodb
 npm install
 npm run watch:run
-
 # open localhost:8080/dashboard in browser
+```

-# run frontend 
+## Running Frontend locally 
+
+```shell
 cd packages/nc-gui
 npm install
 npm run dev
-
 # open localhost:3000/dashboard in browser
 ```

@ -246,12 +283,12 @@ npm run cypress:open

 # Contributing

-Please check out [Contribution Guide](https://github.com/nocodb/nocodb/blob/master/.github/CONTRIBUTING.md)
+Please refer to [Contribution Guide](https://github.com/nocodb/nocodb/blob/master/.github/CONTRIBUTING.md).

 # 🎯 Why are we building this?
 Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by a Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings has meant horrible access controls, vendor lockin, data lockin, abrupt price changes & most importantly a glass ceiling on what's possible in future.

-# ❤ Our Mission :
+# ❤ Our Mission
 Our mission is to provide the most powerful no-code interface for databases which is open source to every single internet business in the world. This would not only democratise access to a powerful computing tool but also bring forth a billion+ people who will have radical tinkering-and-building abilities on internet. 

 # Contributors : 🌻🌻🌻🐝🐝