Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nocodb/nocodb

๐Ÿ”ฅ ๐Ÿ”ฅ ๐Ÿ”ฅ Open Source Airtable Alternative
https://github.com/nocodb/nocodb

admin-dashboard admin-ui airtable airtable-alternative automatic-api hacktoberfest low-code mariadb mysql no-code no-code-database no-code-platform postgresql rest-api restful-api spreadsheet sqlite sqlserver swagger

Last synced: 25 days ago
JSON representation

๐Ÿ”ฅ ๐Ÿ”ฅ ๐Ÿ”ฅ Open Source Airtable Alternative

Lists

README 

        


    


        

            

            


            NocoDB

        

    


    The Open Source Airtable Alternative 







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







[![Node version](https://img.shields.io/badge/node-%3E%3D%2018.14.0-brightgreen)](http://nodejs.org/download/)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)








    Website โ€ข

    Discord โ€ข

    Community โ€ข

    Twitter โ€ข

    Reddit โ€ข

    Documentation




![video avi](https://github.com/nocodb/nocodb/assets/86527202/e2fad786-f211-4dcb-9bd3-aaece83a6783)






[](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](http://reporoster.com/stars/nocodb/nocodb)](https://github.com/nocodb/nocodb/stargazers)



# Quick try



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



> Different commands just indicate the database that NocoDB will use internally for metadata storage, but that doesn't influence the ability to connect to a different database type. 



## Binaries



##### MacOS (x64)



```bash

curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb

```



##### MacOS (arm64)



```bash

curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb

```



##### Linux (x64)



```bash

curl http://get.nocodb.com/linux-x64 -o nocodb -L && chmod +x nocodb && ./nocodb

```



##### Linux (arm64)



```bash

curl http://get.nocodb.com/linux-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb

```



##### Windows (x64)



```bash

iwr http://get.nocodb.com/win-x64.exe -o Noco-win-x64.exe

.\Noco-win-x64.exe

```



##### Windows (arm64)



```bash

iwr http://get.nocodb.com/win-arm64.exe -o Noco-win-arm64.exe

.\Noco-win-arm64.exe

```



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



## NPX



You can run the 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

```



# GUI



Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/dashboard)



# Screenshots

![2](https://github.com/nocodb/nocodb/assets/86527202/a127c05e-2121-4af2-a342-128e0e2d0291)

![3](https://github.com/nocodb/nocodb/assets/86527202/674da952-8a06-4848-a0e8-a7b02d5f5c88)

![4](https://github.com/nocodb/nocodb/assets/86527202/cbc5152a-9caf-4f77-a8f7-92a9d06d025b)

![5](https://github.com/nocodb/nocodb/assets/86527202/dc75dfdc-c486-4f5a-a853-2a8f9e6b569a)



![5](https://user-images.githubusercontent.com/35857179/194844886-a17006e0-979d-493f-83c4-0e72f5a9b716.png)

![7](https://github.com/nocodb/nocodb/assets/86527202/be64e619-7295-43e2-aa95-cace4462b17f)

![8](https://github.com/nocodb/nocodb/assets/86527202/4538bf5a-371f-4ec1-a867-8197e5824286)



![8](https://user-images.githubusercontent.com/35857179/194844893-82d5e21b-ae61-41bd-9990-31ad659bf490.png)

![9](https://user-images.githubusercontent.com/35857179/194844897-cfd79946-e413-4c97-b16d-eb4d7678bb79.png)

![10](https://user-images.githubusercontent.com/35857179/194844902-c0122570-0dd5-41cf-a26f-6f8d71fefc99.png)

![11](https://user-images.githubusercontent.com/35857179/194844903-c1e47f40-e782-4f5d-8dce-6449cc70b181.png)

![12](https://user-images.githubusercontent.com/35857179/194844907-09277d3e-cbbf-465c-9165-6afc4161e279.png)



# Table of Contents



- [Quick try](#quick-try)

    - [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)

- [Contributing](#contributing)

- [Why are we building this?](#why-are-we-building-this)

- [Our Mission](#our-mission)

- [License](#license)

- [Contributors](#contributors)



# Features



### Rich Spreadsheet Interface



- โšก ย Basic Operations: Create, Read, Update and Delete 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, Attachment, Currency, Formula, 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 programmatically invoke actions. 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 one environment to another. See Sync Schema for details.



### Audit



We are keeping all the user operation logs in one place. See Audit for details.



# Production Setup



By default, SQLite is used for storing metadata. However, you can specify your database. The connection parameters 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 the [Environment variables](https://docs.nocodb.com/getting-started/environment-variables)



# Development Setup



Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)



# 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 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 have meant horrible access controls, vendor lock-in, data lock-in, abrupt price changes & most importantly a glass ceiling on what's possible in the future.



# Our Mission



Our mission is to provide the most powerful no-code interface for databases that 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 the internet.



# License





This project is licensed under AGPLv3.




# Contributors



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