NocoDB Documentation

Welcome!

NocoDB is an open source Airtable alternative.

NocoDB works by connecting to any relational database and transforming them into a smart spreadsheet interface! This allows you to build no-code applications collaboratively with teams. NocoDB currently works with MySQL, PostgreSQL, Microsoft SQL Server, SQLite, Amazon Aurora & MariaDB databases.

Also NocoDB's app store allows you to build business workflows on views with combination of Slack, Microsoft Teams, Discord, Twilio, Whatsapp, Email & any 3rd party APIs too. Plus NocoDB provides programmatic access to APIs so that you can build integrations with Zapier / Integromat and custom applications too.

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, Commenter, 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.

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.

Architecture - Simple Overview



Project TypeMetadata stored inData stored in
Create new projectNC_DBNC_DB
Create new project with external DBNC_DBExternal database

NocoDB repository structure

We use Lerna to manage multi-packages. We have the following packages.

  • packages/nc-cli : A CLI to create NocoDB app.

  • packages/nc-common: A common library package used internally.

  • packages/nc-gui: NocoDB Frontend.

  • packages/nc-lib-gui: The build version of nc-gui which will be used in packages/nocodb.

  • packages/nc-migrator-archived: SQL based schema migrations or evolutions.

  • packages/nc-plugin: Plugin template.

  • packages/noco-blog: NocoDB Blog which will be auto-released to nocodb/noco-blog.

  • packages/noco-book: NocoDB Handbook which will be auto-released to nocodb/noco-book.

  • packages/noco-docs: NocoDB Documentation which will be auto-released to nocodb/noco-docs.

  • packages/nocodb: NocoDB Backend, hosted in NPM.

Contributions

All contributions are welcome. NocoDB projects can be found in the NocoDB Github organization. Our core uses The AGPL V3 license and all contributors should read the contribution guides before making your first contribution.

You can also share your thoughts and discuss with our community members via discord or Github Discussion. We also share our Immediate Roadmap and all opinions are welcome.

Support

If you have any issues or questions, you can reach out for help in our discord.