Skip to content
forked from nocodb/nocodb

πŸ”₯ πŸ”₯ πŸ”₯ Open Source Airtable Alternative - turns any MySQL, Postgres, SQLite into a Spreadsheet with REST APIs.

License

Notifications You must be signed in to change notification settings

nocodb/nocodb-1

Β 
Β 

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 β€’ Community β€’ Twitter β€’ Reddit β€’ Documentation

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

Deploy NocoDB to Heroku with 1-Click

See other languages Β»

Join Our Team

Join Our Community

Stargazers repo roster for @nocodb/nocodb

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.

git clone https://github.com/nocodb/nocodb-seed
cd nocodb-seed
npm install
npm start

Docker

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

Binaries

MacOS (x64)
curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb
MacOS (arm64)
curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb
Linux (x64)
curl http://get.nocodb.com/linux-x64 -o nocodb -L && chmod +x nocodb && ./nocodb
Linux (arm64)
curl http://get.nocodb.com/linux-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb
Windows (x64)
iwp http://get.nocodb.com/win-x64 
.\Noco-win-x64.exe
Windows (arm64)
iwp http://get.nocodb.com/win-arm64 
.\Noco-win-arm64.exe

Docker Compose

We provide different docker-compose.yml files under this directory. Here are some examples.

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.

GUI

Access Dashboard using : http://localhost:8080/dashboard

Screenshots

2

1

7

5

6

5

6

11

10

8


9

Table of Contents

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

Development Setup

Please refer to Development Setup

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

πŸ’»

Robin Fourcade

πŸ’»

zprial

πŸ’»

Nils Reichardt

πŸ’»

Naman Anand

πŸ’»

Geo Maciolek

πŸ’»

η₯žζ₯½ε‚εΈ•ηͺ

πŸ’»

Titouan CREACH

πŸ’»

youyiio

πŸ’»

River Kelly

πŸ’»

LepkoQQ

πŸ’»

quentin

πŸ’»

Cande

πŸ’»

About

πŸ”₯ πŸ”₯ πŸ”₯ Open Source Airtable Alternative - turns any MySQL, Postgres, SQLite into a Spreadsheet with REST APIs.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 52.7%
  • Vue 31.6%
  • JavaScript 13.6%
  • PLpgSQL 0.7%
  • HTML 0.5%
  • CSS 0.5%
  • Other 0.4%