- [Docker](https://www.docker.com/get-started) or [Node.js](https://nodejs.org/en/download) ( > v14.x )
- [Node.js with version >= 14](https://nodejs.org/en/download) / [Docker](https://www.docker.com/get-started)
## Quick try
## Quick try
### 1-Click Deploy to Heroku
### 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.
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.
@ -27,88 +26,7 @@ Before doing so, make sure you have a Heroku account. By default, an add-on Hero
/>
/>
</a>
</a>
### NPX
### Docker
You can run below command if you need an interactive configuration.
@ -178,7 +96,7 @@ We provide different docker-compose.yml files under <a href="https://github.com/
<code-group>
<code-group>
<code-blocklabel="MySQL"active>
<code-blocklabel="MySQL"active>
```bash
```bash
git clone https://github.com/nocodb/nocodb
git clone https://github.com/nocodb/nocodb
cd nocodb/docker-compose/mysql
cd nocodb/docker-compose/mysql
@ -196,7 +114,7 @@ We provide different docker-compose.yml files under <a href="https://github.com/
```
```
</code-block>
</code-block>
<code-blocklabel="SQL Server">
<code-blocklabel="SQL Server">
```bash
```bash
@ -216,6 +134,91 @@ Tip 1: To persist data in docker you can mount volume at `/usr/app/data/` since
Tip 2: 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 <ahref="https://github.com/nocodb/nocodb/issues/1313#issuecomment-1046625974"target="_blank">MySQL Docker Compose</a>.
Tip 2: 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 <ahref="https://github.com/nocodb/nocodb/issues/1313#issuecomment-1046625974"target="_blank">MySQL Docker Compose</a>.
</alert>
</alert>
### NPX
You can run below command if you need an interactive configuration.
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
```
## Production Setup
## Production Setup
It is mandatory to configure `NC_DB` environment variables for production usecases.
It is mandatory to configure `NC_DB` environment variables for production usecases.
@ -361,9 +364,6 @@ aws ecs create-service \
If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules.
If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules.
</alert>
</alert>
## Development Setup
Please refer to [Development Setup](https://docs-dev.nocodb.com/engineering/development-setup).