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://img.shields.io/badge/node-%3E%3D%2014.18.0-brightgreen)](http://nodejs.org/download/) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)

WebsiteDiscordCommunityTwitterRedditDocumentation

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

Deploy NocoDB to Heroku with 1-Click

[](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 »

# Join Our Team

# Join Our Community [![Stargazers repo roster for @nocodb/nocodb](https://reporoster.com/stars/nocodb/nocodb)](https://github.com/nocodb/nocodb/stargazers) # Quick try ## 1-Click Deploy to Heroku Before doing so, make sure you have a Heroku account. By default, an add-on Heroku Postgres will be used as meta database. You can see the connection string defined in `DATABASE_URL` by navigating to Heroku App Settings and selecting Config Vars. Deploy NocoDB to Heroku with 1-Click
## NPX You can run below command if you need an interactive configuration. ``` npx create-nocodb-app ``` ## Node Application We provide a simple NodeJS Application for getting started. ```bash git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed npm install npm start ``` ## Docker ```bash # for SQLite docker run -d --name nocodb \ -v "$(pwd)"/nocodb:/usr/app/data/ \ -p 8080:8080 \ nocodb/nocodb:latest # for MySQL docker run -d --name nocodb-mysql \ -v "$(pwd)"/nocodb:/usr/app/data/ \ -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 # for PostgreSQL docker run -d --name nocodb-postgres \ -v "$(pwd)"/nocodb:/usr/app/data/ \ -p 8080:8080 \ -e NC_DB="pg://host.docker.internal:5432?u=root&p=password&d=d1" \ -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ nocodb/nocodb:latest # for MSSQL docker run -d --name nocodb-mssql \ -v "$(pwd)"/nocodb:/usr/app/data/ \ -p 8080:8080 \ -e NC_DB="mssql://host.docker.internal:1433?u=root&p=password&d=d1" \ -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ nocodb/nocodb:latest ``` > To persist data in docker you can mount volume at `/usr/app/data/` since 0.10.6. Otherwise your data will be lost after recreating the container. > 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). ## Docker Compose We provide different docker-compose.yml files under [this directory](https://github.com/nocodb/nocodb/tree/master/docker-compose). Here are some examples. ```bash git clone https://github.com/nocodb/nocodb # for MySQL cd nocodb/docker-compose/mysql # for PostgreSQL cd nocodb/docker-compose/pg # for MSSQL cd nocodb/docker-compose/mssql docker-compose up -d ``` > To persist data in docker, you can mount volume at `/usr/app/data/` since 0.10.6. Otherwise your data will be lost after recreating the container. > 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 Compose](https://github.com/nocodb/nocodb/issues/1313#issuecomment-1046625974). # GUI Access Dashboard using : [http://localhost:8080/dashboard](http://localhost:8080/dashboard) # 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/35857179/163675704-54eb644d-3b5e-45e3-aad4-794a0f55c692.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 to Heroku](#1-click-deploy-to-heroku) * [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) - [Production Setup](#production-setup) * [Environment variables](#environment-variables) - [Development Setup](#development-setup) * [Cloning the Project](#cloning-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 - ⚡  Basic Operations: Create, Read, Update and Delete on Tables, Columns, and Rows - ⚡  Fields Operations: Sort, Filter, Hide / Unhide Columns - ⚡  Multiple Views Types: Grid (By default), Gallery and Form 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 - ⚡  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 ### 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. - ⚡  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. ### Audit We are keeping all the user operation logs under one place. See Audit for details. # 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. ## 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

💻

LancerComet

💻

mertmit

💻

Atom Pi

💻

Oskars

💻

UT from dolibit

💻

Blucky

💻

TsjipTsjip

💻

Dan Horrigan

💻

Amit Joki

💻

Nate

💻

Robin Fourcade

💻

zprial

💻

Nils Reichardt

💻

Naman Anand

💻

Geo Maciolek

💻

神楽坂帕琪

💻

Titouan CREACH

💻

youyiio

💻