From d2e999992b32b0e531d3dfdb31ff5eb9045fa237 Mon Sep 17 00:00:00 2001 From: Damilare Anjorin Date: Tue, 14 Mar 2023 09:22:16 +0100 Subject: [PATCH 1/3] chore: readme typos --- README.md | 84 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 47 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 091309a040..e85c077a7b 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,9 @@

-Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadsheet. +Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart spreadsheet.

-
[![Build Status](https://travis-ci.org/dwyl/esta.svg?branch=master)](https://travis-ci.com/github/NocoDB/NocoDB) @@ -29,7 +28,7 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadshe Twitter • Reddit • Documentation -

+

![All Views](https://user-images.githubusercontent.com/35857179/194825053-3aa3373d-3e0f-4b42-b3f1-42928332054a.gif) @@ -47,12 +46,12 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadshe
-

See other languages »

# Join Our Team +

# Join Our Community @@ -65,14 +64,14 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadshe --> -[![Stargazers repo roster for @nocodb/nocodb](https://reporoster.com/stars/nocodb/nocodb)](https://github.com/nocodb/nocodb/stargazers) +[![Stargazers repo roster for @nocodb/nocodb](https://reporoster.com/stars/nocodb/nocodb)](https://github.com/nocodb/nocodb/stargazers) # Quick try ## NPX -You can run below command if you need an interactive configuration. +You can run the below command if you need an interactive configuration. ``` npx create-nocodb-app @@ -91,7 +90,7 @@ npm install npm start ``` -## Docker +## Docker ```bash # for SQLite @@ -130,32 +129,40 @@ nocodb/nocodb:latest > If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for [MySQL Docker](https://github.com/nocodb/nocodb/issues/1340#issuecomment-1049481043). ## Binaries + ##### MacOS (x64) + ```bash curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb ``` ##### MacOS (arm64) + ```bash curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb ``` ##### Linux (x64) + ```bash curl http://get.nocodb.com/linux-x64 -o nocodb -L && chmod +x nocodb && ./nocodb ``` + ##### Linux (arm64) + ```bash curl http://get.nocodb.com/linux-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb ``` ##### Windows (x64) + ```bash iwr http://get.nocodb.com/win-x64.exe .\Noco-win-x64.exe ``` ##### Windows (arm64) + ```bash iwr http://get.nocodb.com/win-arm64.exe .\Noco-win-arm64.exe @@ -182,7 +189,7 @@ docker-compose up -d # GUI -Access Dashboard using : [http://localhost:8080/dashboard](http://localhost:8080/dashboard) +Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/dashboard)](http://localhost:8080/dashboard) # Screenshots @@ -202,22 +209,22 @@ Access Dashboard using : [http://localhost:8080/dashboard](http://localhost:8080 # Table of Contents - [Quick try](#quick-try) - * [NPX](#npx) - * [Node Application](#node-application) - * [Docker](#docker) - * [Docker Compose](#docker-compose) + - [NPX](#npx) + - [Node Application](#node-application) + - [Docker](#docker) + - [Docker Compose](#docker-compose) - [GUI](#gui) - [Join Our Community](#join-our-community) - [Screenshots](#screenshots) - [Table of Contents](#table-of-contents) - [Features](#features) - + [Rich Spreadsheet Interface](#rich-spreadsheet-interface) - + [App Store for Workflow Automations](#app-store-for-workflow-automations) - + [Programmatic Access](#programmatic-access) - + [Sync Schema](#sync-schema) - + [Audit](#audit) + - [Rich Spreadsheet Interface](#rich-spreadsheet-interface) + - [App Store for Workflow Automations](#app-store-for-workflow-automations) + - [Programmatic Access](#programmatic-access) + - [Sync Schema](#sync-schema) + - [Audit](#audit) - [Production Setup](#production-setup) - * [Environment variables](#environment-variables) + - [Environment variables](#environment-variables) - [Development Setup](#development-setup) - [Contributing](#contributing) - [Why are we building this?](#why-are-we-building-this) @@ -229,47 +236,47 @@ Access Dashboard using : [http://localhost:8080/dashboard](http://localhost:8080 ### Rich Spreadsheet Interface -- ⚡  Basic Operations: Create, Read, Update and Delete on Tables, Columns, and Rows +- ⚡  Basic Operations: Create, Read, Update and Delete Tables, Columns, and Rows - ⚡  Fields Operations: Sort, Filter, Hide / Unhide Columns - ⚡  Multiple Views Types: Grid (By default), Gallery, Form View and Kanban View -- ⚡  View Permissions Types: Collaborative Views, & Locked Views +- ⚡  View Permissions Types: Collaborative Views, & Locked Views - ⚡  Share Bases / Views: either Public or Private (with Password Protected) - ⚡  Variant Cell Types: ID, LinkToAnotherRecord, Lookup, Rollup, SingleLineText, Attachement, Currency, Formula and etc -- ⚡  Access Control with Roles : Fine-grained Access Control at different levels +- ⚡  Access Control with Roles: Fine-grained Access Control at different levels - ⚡  and more ... ### App Store for Workflow Automations We provide different integrations in three main categories. See App Store for details. -- ⚡  Chat : Slack, Discord, Mattermost, and etc -- ⚡  Email : AWS SES, SMTP, MailerSend, and etc -- ⚡  Storage : AWS S3, Google Cloud Storage, Minio, and etc +- ⚡  Chat: Slack, Discord, Mattermost, and etc +- ⚡  Email: AWS SES, SMTP, MailerSend, and etc +- ⚡  Storage: AWS S3, Google Cloud Storage, Minio, and etc ### Programmatic Access -We provide the following ways to let users to invoke actions in a programmatic way. You can use a token (either JWT or Social Auth) to sign your requests for authorization to NocoDB. +We provide the following ways to let users programmatically invoke actions. You can use a token (either JWT or Social Auth) to sign your requests for authorization to NocoDB. - ⚡  REST APIs - ⚡  NocoDB SDK ### Sync Schema -We allow you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from environment to others. See Sync Schema for details. +We allow you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from one environment to another. See Sync Schema for details. -### Audit +### Audit -We are keeping all the user operation logs under one place. See Audit for details. +We are keeping all the user operation logs in one place. See Audit for details. -# Production Setup +# Production Setup -By default, SQLite is used for storing meta data. However, you can specify your own database. The connection params for this database can be specified in `NC_DB` environment variable. Moreover, we also provide the below environment variables for configuration. +By default, SQLite is used for storing metadata. However, you can specify your database. The connection parameters for this database can be specified in `NC_DB` environment variable. Moreover, we also provide the below environment variables for configuration. -## Environment variables +## Environment variables -Please refer to [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) +Please refer to the [Environment](https://docs.nocodb.com/getting-started/environment-variables)[ variables](https://docs.nocodb.com/getting-started/environment-variables)](https://docs.nocodb.com/getting-started/environment-variables) -# Development Setup +# Development Setup Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup) @@ -278,12 +285,15 @@ Please refer to [Development Setup](https://docs.nocodb.com/engineering/developm 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. + +Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by 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 have meant horrible access controls, vendor lock-in, data lock-in, abrupt price changes & most importantly a glass ceiling on what's possible in the future. # 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. -# License +Our mission is to provide the most powerful no-code interface for databases that 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 the internet. + +# License +

This project is licensed under AGPLv3.

@@ -294,4 +304,4 @@ Thank you for your contributions! We appreciate all the contributions from the c - \ No newline at end of file + From 7c0987f2864edd33dd44e6c2c978965365a63e74 Mon Sep 17 00:00:00 2001 From: Damilare Anjorin Date: Tue, 14 Mar 2023 11:04:29 +0100 Subject: [PATCH 2/3] chore: fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e85c077a7b..6a09829d11 100644 --- a/README.md +++ b/README.md @@ -274,7 +274,7 @@ By default, SQLite is used for storing metadata. However, you can specify your d ## Environment variables -Please refer to the [Environment](https://docs.nocodb.com/getting-started/environment-variables)[ variables](https://docs.nocodb.com/getting-started/environment-variables)](https://docs.nocodb.com/getting-started/environment-variables) +Please refer to the [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Development Setup From b4565483f453f4ef8f002542cff35c5166bf074e Mon Sep 17 00:00:00 2001 From: Damilare Anjorin Date: Tue, 14 Mar 2023 13:27:57 +0100 Subject: [PATCH 3/3] chore: update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a09829d11..3758c0db19 100644 --- a/README.md +++ b/README.md @@ -189,7 +189,7 @@ docker-compose up -d # GUI -Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/dashboard)](http://localhost:8080/dashboard) +Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/dashboard) # Screenshots @@ -241,7 +241,7 @@ Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/ - ⚡  Multiple Views Types: Grid (By default), Gallery, Form View and Kanban View - ⚡  View Permissions Types: Collaborative Views, & Locked Views - ⚡  Share Bases / Views: either Public or Private (with Password Protected) -- ⚡  Variant Cell Types: ID, LinkToAnotherRecord, Lookup, Rollup, SingleLineText, Attachement, Currency, Formula and etc +- ⚡  Variant Cell Types: ID, LinkToAnotherRecord, Lookup, Rollup, SingleLineText, Attachment, Currency, Formula, etc - ⚡  Access Control with Roles: Fine-grained Access Control at different levels - ⚡  and more ...