NocoDB
The Open Source Airtable Alternative

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) [![Node version](https://badgen.net/npm/node/next)](http://nodejs.org/download/) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)

Website • Discord • Twitter • Reddit • Documentation

The Open Source Airtable Alternative - works on MySQL, Postgres SQL Server & MariaDB

[

](scripts/markdown/readme/languages/chinese.md) [

](scripts/markdown/readme/languages/french.md) [

](scripts/markdown/readme/languages/german.md) [

](scripts/markdown/readme/languages/spanish.md) [

](scripts/markdown/readme/languages/portuguese.md) [

](scripts/markdown/readme/languages/italian.md) [

](scripts/markdown/readme/languages/japanese.md) [

](scripts/markdown/readme/languages/korean.md) [

](scripts/markdown/readme/languages/russian.md)

See other languages »

# Quick try ### 1-Click Deploy #### Heroku

### Using Docker ```bash docker run -d --name nocodb -p 8080:8080 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 cd nocodb-seed npm install npm start ``` ### GUI Access Dashboard using : [http://localhost:8080/dashboard](http://localhost:8080/dashboard) # Join Our Community

# Screenshots ![2](https://user-images.githubusercontent.com/5435402/133759229-4275b934-873b-4a9b-9f23-96470fec9775.png)
![1](https://user-images.githubusercontent.com/5435402/133759218-f8b0bffc-707f-451c-82f2-b5ba2573d6a6.png)
![7](https://user-images.githubusercontent.com/5435402/133759245-a536165b-55f1-46a8-a74e-1964e7e481c6.png)
![5](https://user-images.githubusercontent.com/5435402/133759240-dd3f2509-aab7-4bd1-9a58-4c2dff08f2f2.png)
![6](https://user-images.githubusercontent.com/5435402/133759242-2311a127-17c8-406c-b865-1a2e9c8ee398.png)
![5](https://user-images.githubusercontent.com/35857179/151526876-f6a0e472-9bbc-45ba-a771-9118e03bc748.png)
![6](https://user-images.githubusercontent.com/35857179/151526883-4c670f8b-7c5c-421f-9e95-54d3a84a72ba.png)
![11](https://user-images.githubusercontent.com/5435402/133759253-bb9bc729-ee28-4f86-ab95-7d112c0815f2.png)
![10](https://user-images.githubusercontent.com/5435402/133759250-ebd75ecf-31db-4a17-b2d7-2c43af78a54e.png)
![8](https://user-images.githubusercontent.com/5435402/133759248-3a7141e0-4b7d-4079-a5f9-cf8611d00bc5.png)
![9](https://user-images.githubusercontent.com/5435402/133759249-8c1a85c2-a55c-48f6-bd58-aa6b4195cce7.png) # 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) - [Join Our Community](#join-our-community) - [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) # Features ### 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, Viewer, Commenter, Custom Roles. - ⚡ Access Control : Fine-grained access control even at database, table & column level. ### 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. # 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 #### Example: MySQL ``` 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:latest ``` #### Example: PostgreSQL ``` 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:latest ``` #### Example: SQL Server ``` 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:latest ``` ## Docker Compose ``` git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose cd mysql or pg or mssql docker-compose up ``` ## Environment variables Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) # Development Setup ## Cloning the Project ```shell git clone https://github.com/nocodb/nocodb cd nocodb ``` ## Running Backend locally ```shell cd packages/nocodb npm install npm run watch:run # open localhost:8080/dashboard in browser ``` ## Running Frontend locally ```shell cd packages/nc-gui npm install npm run dev # open localhost:3000/dashboard in browser ``` Changes made to code automatically restart. > nocodb/packages/nocodb includes nc-lib-gui which is the built version of nc-gui hosted in npm registry. You can visit localhost:8000/dashboard in browser after starting the backend locally if you just want to modify the backend only. ## Running Cypress tests locally ```shell # install dependencies(cypress) npm install # run mysql database with required database using docker compose docker-compose -f ./scripts/docker-compose-cypress.yml up # Run backend api using following command npm run start:api # Run frontend web UI using following command npm run start:web # wait until both 3000 and 8080 ports are available # and run cypress test using following command npm run cypress:run # or run following command to run it with GUI npm run cypress:open ``` # Contributing 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 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 [//]: contributor-faces

_o1lab 💻	_{Pranav C} 💻	_{Boris van Katwijk} 💻	_{Markus Bergholz} 💻	_{Daniel Ruf} 💻	_{Bert Verhelst} 💻	_JaeWon 💻
_0xflotus 💻	_{Simon Guionniere} 💻	_eXtremeSHOK 💻	_v2io 💻	_{Stanislav Oaserele} 💻	_{Ahmad Anshorimuslim Syuhada} 💻	_{Yaraslau Kurmyza} 💻
_{Fernando van Loenhout} 💻	_jrevault 💻	_{Átila Camurça Alves} 💻	_{Simon Bowen} 💻	_{աɨռɢӄաօռɢ} 💻	_{Ferdinand Gassauer} 💻	_{George Daneke} 💻
_{Jens Willmer} 💻	_{Bhanu Pratap Chaudhary} 💻	_{Joel Wetzell} 💻	_SebGTx 💻	_{Faraz Patankar} 💻	_PixPlix 💻	_{Alejandro Giacometti} 💻
_{Bruno Moreira} 💻	_AztrexDX 💻	_ejose19 💻	_Maxime 💻	_dstala 💻	_loftwah 💻	_{Martin Gersbach} 💻
_ArjenR 💻	_{조진식 (Jo Jinsik)} 💻	_tianchunfeng 💻	_Andrea 💻	_{Giulio Malventi} 💻	_{Md. Ishtiaque Zafar} 💻	_ChasLui 💻
_{Zhansaya Maksut} 💻	_agkfri 💻	_Ziqi 💻	_{Allan Siqueira} 💻	_Fatih 💻	_{Roman Rezinkin} 💻	_{Francisco Gallardo} 💻
_{Simon B.} 💻	_{Liel Fridman} 💻	_rubjo 💻	_{Kinga Marszałkowska} 💻	_{Christof Horschitz} 💻	_Simone 💻	_{Tyo Nirwansyah} 💻
_jiwon 💻	_{Mike P. Sinn} 💻	_candideu 💻	_SiderealArt 💻	_{Vijay Rathore} 💻	_{John Appleseed} 💻	_{Salem Korayem} 💻
_标 💻	_{诗人的咸鱼} 💻	_bitbytejoy 💻	_pan93412 💻

NocoDB The Open Source Airtable Alternative

NocoDB
The Open Source Airtable Alternative