mirror of https://github.com/nocodb/nocodb
Naveen MR
3 years ago
1 changed files with 307 additions and 0 deletions
@ -0,0 +1,307 @@
|
||||
<h1 align="center" style="border-bottom: none"> |
||||
<b> |
||||
<a href="https://www.nocodb.com">NocoDB </a><br> |
||||
</b> |
||||
✨ L'alternative à air open source ✨ <br> |
||||
|
||||
</h1> |
||||
<p align="center"> |
||||
Tournez n'importe quel MySQL, PostgreSQL, SQL Server, SQLite & Mariadb dans une feuille de calcul intelligente. |
||||
</p> |
||||
<div align="center"> |
||||
|
||||
[](https://travis-ci.com/github/NocoDB/NocoDB) |
||||
[](http://nodejs.org/download/) |
||||
[](https://twitter.com/NocoDB) |
||||
|
||||
</div> |
||||
|
||||
<p align="center"> |
||||
<a href="http://www.nocodb.com"><b>Website</b></a> • |
||||
<a href="https://discord.gg/5RgZmkW"><b>Discord</b></a> • |
||||
<a href="https://twitter.com/nocodb"><b>Twitter</b></a> |
||||
</p> |
||||
|
||||
 |
||||
|
||||
<img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" /> |
||||
|
||||
<a href="https://www.producthunt.com/posts/nocodb?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-nocodb" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=297536&theme=dark" alt="NocoDB - The Open Source Airtable alternative | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a> |
||||
|
||||
|
||||
# Essayer rapidement |
||||
### 1-Click Deploy |
||||
|
||||
#### Heroku |
||||
<a href="https://heroku.com/deploy?template=https://github.com/npgia/nocodb-seed-heroku"> |
||||
<img |
||||
src="https://www.herokucdn.com/deploy/button.svg" |
||||
width="300px" |
||||
alt="Deploy NocoDB to Heroku with 1-Click" |
||||
/> |
||||
</a> |
||||
<br> |
||||
|
||||
### Utiliser Docker |
||||
```bash |
||||
docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest |
||||
``` |
||||
|
||||
> To persist data you can mount volume at `/usr/app/data/`. |
||||
|
||||
### En utilisant npm |
||||
``` |
||||
npx create-nocodb-app |
||||
``` |
||||
### En utilisant git |
||||
``` |
||||
git clone https://github.com/nocodb/nocodb-seed |
||||
cd nocodb-seed |
||||
npm install |
||||
npm start |
||||
``` |
||||
|
||||
### GUI |
||||
|
||||
Accès au tableau de bord en utilisant : [http://localhost:8080/dashboard](http://localhost:8080/dashboard) |
||||
|
||||
|
||||
# Rejoignez notre communauté |
||||
<a href="https://discord.gg/5RgZmkW"> |
||||
<img |
||||
src="https://invidget.switchblade.xyz/5RgZmkW" |
||||
alt="Join NocoDB : Free & Open Source Airtable Alternative" |
||||
> |
||||
</a> |
||||
<br> |
||||
|
||||
# Captures d'écran |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
<br> |
||||
|
||||
 |
||||
|
||||
|
||||
|
||||
# Caractéristiques |
||||
### Interface de feuille de calcul riche |
||||
|
||||
⚡ Recherche, trier, filtrer, masquer les colonnes avec Uber Facile |
||||
⚡ Créer des vues: grille, galerie, kanban, gantt, forme |
||||
⚡ Partager des vues: Public & Mot de passe protégé |
||||
⚡ Vues personnelles et verrouillées |
||||
⚡ Télécharger des images sur les cellules (fonctionne avec S3, Minio, GCP, Azure, DigitalOcean, Linode, Ovh, Backblaze) !! |
||||
⚡ Rôles: propriétaire, créateur, éditeur, commentateur, spectateur, commentateur, rôles personnalisés. |
||||
Contrôle d'accès: contrôle d'accès à grain fin, même à la base de données, au niveau de la table et de la colonne. |
||||
|
||||
### App Store for Workflow Automation: |
||||
⚡ Chat: équipes de Microsoft, relais, discorde, la plus grande |
||||
⚡ Email: SMTP, SES, MailChimp |
||||
⚡ SMS: Twilio |
||||
⚡ WhatsApp |
||||
⚡ Toute API tierce |
||||
|
||||
### Accès d'API programmatique via: |
||||
⚡ Apis de repos (Swagger) |
||||
⚡ API GraphQL. |
||||
⚡ inclut l'authentification JWT et l'authentification sociale |
||||
⚡ Jetons API à intégrer avec Zapier, Integromat. |
||||
|
||||
|
||||
# Production Setup |
||||
NocoDB requires a database to store metadata of spreadsheets views and external databases. |
||||
And connection params for this database can be specified in `NC_DB` environment variable. |
||||
|
||||
## Docker |
||||
|
||||
#### Example MySQL |
||||
``` |
||||
docker run -d -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 |
||||
``` |
||||
|
||||
#### Example Postgres |
||||
``` |
||||
docker run -d -p 8080:8080 \ |
||||
-e NC_DB="pg://host:port?u=user&p=password&d=database" \ |
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ |
||||
nocodb/nocodb:latest |
||||
``` |
||||
|
||||
#### Example SQL Server |
||||
``` |
||||
docker run -d -p 8080:8080 \ |
||||
-e NC_DB="mssql://host:port?u=user&p=password&d=database" \ |
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ |
||||
nocodb/nocodb:latest |
||||
``` |
||||
|
||||
## Docker Compose |
||||
``` |
||||
git clone https://github.com/nocodb/nocodb |
||||
cd docker-compose |
||||
cd mysql or pg or mssql |
||||
docker-compose up |
||||
``` |
||||
|
||||
|
||||
## Environment variables |
||||
| Variable | Mandatory | Comments | If absent | |
||||
|-------------------------|-----------|----------------------------------------------------------------------------------|--------------------------------------------| |
||||
| NC_DB | Yes | See our database URLs | A local SQLite will be created in root folder | |
||||
| DATABASE_URL | No | JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| | |
||||
| DATABASE_URL_FILE | No | path to file containing JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| | |
||||
| NC_PUBLIC_URL | Yes | Used for sending Email invitations | Best guess from http request params | |
||||
| NC_AUTH_JWT_SECRET | Yes | JWT secret used for auth and storing other secrets | A Random secret will be generated | |
||||
| NC_SENTRY_DSN | No | For Sentry monitoring | | |
||||
| NC_CONNECT_TO_EXTERNAL_DB_DISABLED | No | Disable Project creation with external database | | |
||||
| NC_DISABLE_TELE | No | Disable telemetry | | |
||||
| NC_BACKEND_URL | No | Custom Backend URL | ``http://localhost:8080`` will be used | |
||||
|
||||
# Development setup |
||||
``` |
||||
git clone https://github.com/nocodb/nocodb |
||||
cd nocodb |
||||
|
||||
# run backend |
||||
cd packages/nocodb |
||||
npm install |
||||
npm run watch:run |
||||
|
||||
# open localhost:8080/dashboard in browser |
||||
|
||||
# run frontend |
||||
cd packages/nc-gui |
||||
npm install |
||||
npm run dev |
||||
|
||||
# open localhost:3000/dashboard in browser |
||||
``` |
||||
|
||||
Changes made to code automatically restart. |
||||
|
||||
|
||||
## Running Cypress tests locally |
||||
|
||||
```shell |
||||
# install dependencies(cypress) |
||||
npm install |
||||
|
||||
# run required services by using docker compose |
||||
docker-compose -f ./docker-compose-cypress.yml up |
||||
|
||||
|
||||
|
||||
# wait until both 3000 and 8080 porta are avalable |
||||
# and run cypress test using following command |
||||
npm run cypress:run |
||||
|
||||
# or run following command to run it with GUI |
||||
npm run cypress:open |
||||
``` |
||||
|
||||
# Contributing |
||||
- Please take a look at ./contribute/HowToApplyLicense.md |
||||
- Ignore adding headers for .json or .md or .yml |
||||
|
||||
# 🎯 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 : 🌻🌻🌻🐝🐝 |
||||
[//]: contributor-faces |
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
||||
<!-- prettier-ignore-start --> |
||||
<!-- markdownlint-disable --> |
||||
<table> |
||||
<tr> |
||||
<td align="center"><a href="https://github.com/o1lab"><img src="https://avatars.githubusercontent.com/u/5435402?v=4?s=100" width="100px;" alt=""/><br /><sub><b>o1lab</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=o1lab" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/pranavxc"><img src="https://avatars.githubusercontent.com/u/61551451?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Pranav C</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=pranavxc" title="Code">💻</a></td> |
||||
<td align="center"><a href="http://bvkatwijk.nl/"><img src="https://avatars.githubusercontent.com/u/18490578?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Boris van Katwijk</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=bvkatwijk" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://stackshare.io/markuman/my-stack"><img src="https://avatars.githubusercontent.com/u/3920157?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Markus Bergholz</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=markuman" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://daniel-ruf.de/"><img src="https://avatars.githubusercontent.com/u/827205?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Daniel Ruf</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=DanielRuf" title="Code">💻</a></td> |
||||
<td align="center"><a href="http://bertverhelst.ga/"><img src="https://avatars.githubusercontent.com/u/1710840?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bert Verhelst</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=bertyhell" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/chocholand"><img src="https://avatars.githubusercontent.com/u/6572227?v=4?s=100" width="100px;" alt=""/><br /><sub><b>JaeWon</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=chocholand" title="Code">💻</a></td> |
||||
</tr> |
||||
<tr> |
||||
<td align="center"><a href="https://github.com/0xflotus"><img src="https://avatars.githubusercontent.com/u/26602940?v=4?s=100" width="100px;" alt=""/><br /><sub><b>0xflotus</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=0xflotus" title="Code">💻</a></td> |
||||
<td align="center"><a href="http://www.simonguionniere.com/"><img src="https://avatars.githubusercontent.com/u/3633017?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Simon Guionniere</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=sguionni" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://clients.extremeshok.com/"><img src="https://avatars.githubusercontent.com/u/5957328?v=4?s=100" width="100px;" alt=""/><br /><sub><b>eXtremeSHOK</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=extremeshok" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/v2io"><img src="https://avatars.githubusercontent.com/u/48987429?v=4?s=100" width="100px;" alt=""/><br /><sub><b>v2io</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=v2io" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/soaserele"><img src="https://avatars.githubusercontent.com/u/1093368?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stanislav Oaserele</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=soaserele" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://ans4175.dev/"><img src="https://avatars.githubusercontent.com/u/3961872?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ahmad Anshorimuslim Syuhada</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=ans-4175" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/lotas"><img src="https://avatars.githubusercontent.com/u/83861?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yaraslau Kurmyza</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=lotas" title="Code">💻</a></td> |
||||
</tr> |
||||
<tr> |
||||
<td align="center"><a href="http://stackexchange.com/users/1677570/ferrybig"><img src="https://avatars.githubusercontent.com/u/1576684?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fernando van Loenhout</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=ferrybig" title="Code">💻</a></td> |
||||
<td align="center"><a href="http://blog.quidquid.fr/"><img src="https://avatars.githubusercontent.com/u/1001585?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jrevault</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=jrevault" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/atilacamurca"><img src="https://avatars.githubusercontent.com/u/508624?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Átila Camurça Alves</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=atilacamurca" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/simonbowen"><img src="https://avatars.githubusercontent.com/u/8931?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Simon Bowen</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=simonbowen" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://wingk-wong.blogspot.com/"><img src="https://avatars.githubusercontent.com/u/35857179?v=4?s=100" width="100px;" alt=""/><br /><sub><b>աɨռɢӄաօռɢ</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=wingkwong" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/ferdiga"><img src="https://avatars.githubusercontent.com/u/6248560?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ferdinand Gassauer</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=ferdiga" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://daneke.ru/"><img src="https://avatars.githubusercontent.com/u/4980165?v=4?s=100" width="100px;" alt=""/><br /><sub><b>George Daneke</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=Flatroy" title="Code">💻</a></td> |
||||
</tr> |
||||
<tr> |
||||
<td align="center"><a href="https://jwillmer.de/"><img src="https://avatars.githubusercontent.com/u/1503577?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jens Willmer</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=jwillmer" title="Code">💻</a></td> |
||||
<td align="center"><a href="http://bhanu.io/"><img src="https://avatars.githubusercontent.com/u/2958857?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bhanu Pratap Chaudhary</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=bhanuc" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/jwetzell"><img src="https://avatars.githubusercontent.com/u/18341515?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joel Wetzell</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=jwetzell" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/SebGTx"><img src="https://avatars.githubusercontent.com/u/8062146?v=4?s=100" width="100px;" alt=""/><br /><sub><b>SebGTx</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=SebGTx" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://farazpatankar.com/"><img src="https://avatars.githubusercontent.com/u/10681116?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Faraz Patankar</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=FarazPatankar" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://pixplix.com/"><img src="https://avatars.githubusercontent.com/u/71349937?v=4?s=100" width="100px;" alt=""/><br /><sub><b>PixPlix</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=pixplix" title="Code">💻</a></td> |
||||
<td align="center"><a href="http://alejandro.giacometti.me/"><img src="https://avatars.githubusercontent.com/u/31504?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alejandro Giacometti</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=janrito" title="Code">💻</a></td> |
||||
</tr> |
||||
<tr> |
||||
<td align="center"><a href="https://brunomoreira.opo.pt"><img src="https://avatars.githubusercontent.com/u/3017910?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bruno Moreira</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=bmscmoreira" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/AztrexDX"><img src="https://avatars.githubusercontent.com/u/86340924?v=4?s=100" width="100px;" alt=""/><br /><sub><b>AztrexDX</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=AztrexDX" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/ejose19"><img src="https://avatars.githubusercontent.com/u/8742215?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ejose19</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=ejose19" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/maximeag"><img src="https://avatars.githubusercontent.com/u/3855368?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Maxime</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=maximeag" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/dstala"><img src="https://avatars.githubusercontent.com/u/86527202?v=4?s=100" width="100px;" alt=""/><br /><sub><b>dstala</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=dstala" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://github.com/loftwah"><img src="https://avatars.githubusercontent.com/u/19922556?v=4?s=100" width="100px;" alt=""/><br /><sub><b>loftwah</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=loftwah" title="Code">💻</a></td> |
||||
<td align="center"><a href="https://museosabiertos.org"><img src="https://avatars.githubusercontent.com/u/693328?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Martin Gersbach</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=mrtngrsbch" title="Code">💻</a></td> |
||||
</tr> |
||||
<tr> |
||||
<td align="center"><a href="https://github.com/ArjenR"><img src="https://avatars.githubusercontent.com/u/4269186?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ArjenR</b></sub></a><br /><a href="https://github.com/nocodb/nocodb/commits?author=ArjenR" title="Code">💻</a></td> |
||||
</tr> |
||||
</table> |
||||
|
||||
<!-- markdownlint-restore --> |
||||
<!-- prettier-ignore-end --> |
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END --> |
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in new issue