Skip to content

dstala/nc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

NocoDB
The Open Source Airtable Alternative

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

Build Status Node version Conventional Commits

Website β€’ Discord β€’ Twitter β€’ Reddit β€’ Documentation

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

NocoDB - The Open Source Airtable alternative | Product Hunt

See other languages Β»

Quick try

1-Click Deploy

Heroku

Deploy NocoDB to Heroku with 1-Click

Using Docker

docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest
  • NocoDB needs a database as input : See 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

Join Our Community

Screenshots

2

1

7

5

6

5

6

11

10

8

9

Table of Contents

Features

Rich Spreadsheet Interface

  • ⚑ Β Search, sort, filter, hide columns with uber ease
  • ⚑ Β Create Views : Grid, Gallery, Kanban, 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 -d

Environment variables

Please refer to Environment variables

Development Setup

Cloning the Project

git clone https://github.com/nocodb/nocodb
cd nocodb

Running Backend locally

cd packages/nocodb
npm install
npm run watch:run
# open localhost:8080/dashboard in browser

Running Frontend locally

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

# 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.

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


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

πŸ’»