NocoDB

Open Source Airtable Alternative

CMSSpreadsheet
nocodb/nocodbnocodb.comnocodb

README


            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


All Views

      <img
      src="https://www.herokucdn.com/deploy/button.svg"
      width="300px"
      alt="Deploy NocoDB to Heroku with 1-Click"
      />


[](markdown/readme/languages/chinese.md)[](markdown/readme/languages/french.md)[](markdown/readme/languages/german.md)[](markdown/readme/languages/spanish.md)[](markdown/readme/languages/portuguese.md)[](markdown/readme/languages/italian.md)[](markdown/readme/languages/japanese.md)[](markdown/readme/languages/korean.md)[](markdown/readme/languages/russian.md)

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.

    <img
    src="https://www.herokucdn.com/deploy/button.svg"
    width="300px"
    alt="Deploy NocoDB to Heroku with 1-Click"
    />


NPX


You can run below command if you need an interactive configuration.

  1. ```
  2. npx create-nocodb-app
  3. ```


Node Application


We provide a simple NodeJS Application for getting started.

  1. ``` sh
  2. git clone https://github.com/nocodb/nocodb-seed
  3. cd nocodb-seed
  4. npm install
  5. npm start
  6. ```

Docker


  1. ``` sh
  2. # for SQLite
  3. docker run -d --name nocodb \
  4. -v "$(pwd)"/nocodb:/usr/app/data/ \
  5. -p 8080:8080 \
  6. nocodb/nocodb:latest

  8. # for MySQL
  9. docker run -d --name nocodb-mysql \
  10. -v "$(pwd)"/nocodb:/usr/app/data/ \
  11. -p 8080:8080 \
  12. -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \
  13. -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
  14. nocodb/nocodb:latest

  16. # for PostgreSQL
  17. docker run -d --name nocodb-postgres \
  18. -v "$(pwd)"/nocodb:/usr/app/data/ \
  19. -p 8080:8080 \
  20. -e NC_DB="pg://host.docker.internal:5432?u=root&p=password&d=d1" \
  21. -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
  22. nocodb/nocodb:latest

  24. # for MSSQL
  25. docker run -d --name nocodb-mssql \
  26. -v "$(pwd)"/nocodb:/usr/app/data/ \
  27. -p 8080:8080 \
  28. -e NC_DB="mssql://host.docker.internal:1433?u=root&p=password&d=d1" \
  29. -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
  30. nocodb/nocodb:latest
  31. ```

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)
  1. ``` sh
  2. curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb
  3. ```

MacOS (arm64)
  1. ``` sh
  2. curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb
  3. ```

Linux (x64)
  1. ``` sh
  2. curl http://get.nocodb.com/linux-x64 -o nocodb -L && chmod +x nocodb && ./nocodb
  3. ```
Linux (arm64)
  1. ``` sh
  2. curl http://get.nocodb.com/linux-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb
  3. ```

Windows (x64)
  1. ``` sh
  2. iwr http://get.nocodb.com/win-x64.exe
  3. .\Noco-win-x64.exe
  4. ```

Windows (arm64)
  1. ``` sh
  2. iwr http://get.nocodb.com/win-arm64.exe
  3. .\Noco-win-arm64.exe
  4. ```

Docker Compose


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

  1. ``` sh
  2. git clone https://github.com/nocodb/nocodb
  3. # for MySQL
  4. cd nocodb/docker-compose/mysql
  5. # for PostgreSQL
  6. cd nocodb/docker-compose/pg
  7. # for MSSQL
  8. cd nocodb/docker-compose/mssql
  9. docker-compose up -d
  10. ```

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


1
2
3
4
5
6
7
8
9
10
11
12

Table of Contents


- Quick try
  1-Click Deploy to Heroku
  NPX
  Node Application
  Docker
  Docker Compose
- GUI
- Join Our Community
- Screenshots
- Table of Contents
- Features
    + Rich Spreadsheet Interface
    + App Store for Workflow Automations
    + Programmatic Access
    + Sync Schema
    + Audit
- Production Setup
  Environment variables
- Development Setup
- Contributing
- Why are we building this?
- Our Mission
- License
- 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, 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
- ⚡  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.

License

This project is licensed under AGPLv3.


Contributors


Thank you for your contributions! We appreciate all the contributions from the community.