From a3350e8963f104eeca604f5929b5c2b0798566dc Mon Sep 17 00:00:00 2001 From: Naveen MR Date: Mon, 26 Jun 2023 18:05:41 +0100 Subject: [PATCH] chore : updating readme of nocodb package. It was using nestjs readme --- packages/nocodb/README.md | 323 ++++++++++++++++++++++++++++++++------ 1 file changed, 278 insertions(+), 45 deletions(-) diff --git a/packages/nocodb/README.md b/packages/nocodb/README.md index 00a13b112a..8bcddc8cd8 100644 --- a/packages/nocodb/README.md +++ b/packages/nocodb/README.md @@ -1,73 +1,306 @@ +

+
+ + +
+ NocoDB + +
+ The Open Source Airtable Alternative
+

+

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

-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 -[circleci-url]: https://circleci.com/gh/nestjs/nest - -

A progressive Node.js framework for building efficient and scalable server-side applications.

-

-NPM Version -Package License -NPM Downloads -CircleCI -Coverage -Discord -Backers on Open Collective -Sponsors on Open Collective - - Support us - +

+ +[![Node version](https://img.shields.io/badge/node-%3E%3D%2016.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

- -## Description +![All Views](https://user-images.githubusercontent.com/35857179/194825053-3aa3373d-3e0f-4b42-b3f1-42928332054a.gif) + +
+ +[](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](https://reporoster.com/stars/nocodb/nocodb)](https://github.com/nocodb/nocodb/stargazers) + +# Quick try + +## NPX + +You can run the below command if you need an interactive configuration. + +``` +npx create-nocodb-app +``` + + -[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. +## Node Application -## Installation +We provide a simple NodeJS Application for getting started. ```bash -$ npm install +git clone https://github.com/nocodb/nocodb-seed +cd nocodb-seed +npm install +npm start ``` -## Running the app +## Docker ```bash -# development -$ npm run start +# 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 -# watch mode -$ npm run start:dev +# 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 -# production mode -$ npm run start:prod +# 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 ``` -## Test +> 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). + +## Binaries + +##### MacOS (x64) ```bash -# unit tests -$ npm run test +curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb +``` -# e2e tests -$ npm run test:e2e +##### MacOS (arm64) -# test coverage -$ npm run test:cov +```bash +curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb ``` -## Support +##### Linux (x64) + +```bash +curl http://get.nocodb.com/linux-x64 -o nocodb -L && chmod +x nocodb && ./nocodb +``` -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). +##### Linux (arm64) -## Stay in touch +```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 +.\Noco-win-x64.exe +``` + +##### Windows (arm64) + +```bash +iwr http://get.nocodb.com/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). + +# GUI + +Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/dashboard) + +# Screenshots + +![1](https://user-images.githubusercontent.com/35857179/194844858-d353bd15-1edf-406c-889b-ba60f76831f4.png) +![2](https://user-images.githubusercontent.com/35857179/194844872-1a1094b9-761b-4ab6-a0ab-8e11dcae6571.png) +![3](https://user-images.githubusercontent.com/35857179/194844881-23f12c4c-7a5f-403e-928c-ef4c53b2665d.png) +![4](https://user-images.githubusercontent.com/35857179/194844885-faaf042f-bad2-4924-84f0-2c08813271d8.png) +![5](https://user-images.githubusercontent.com/35857179/194844886-a17006e0-979d-493f-83c4-0e72f5a9b716.png) +![6](https://user-images.githubusercontent.com/35857179/194844890-b9f265ae-6e40-4fa5-9267-d1367c27c8e6.png) +![7](https://user-images.githubusercontent.com/35857179/194844891-bee9aea3-aff3-4247-a918-b2f3fbbc672e.png) +![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. +

-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) +# Contributors -## License +Thank you for your contributions! We appreciate all the contributions from the community. -Nest is [MIT licensed](LICENSE). + + +