README.md

ERdoc Playground

ERdoc Plaground | Documentation

ERdoc is a markup language for creating Entity-Relationship models through text (ER documents). The Playground is a web-based tool to visualize ER documents as ER diagrams using common notations. Get started with the syntax by reading the documentation.

Set up the project

To install the project locally follow this steps:

Clone the project

git clone https://github.com/matias-lg/er

Install dependencies

npm install

Build the ERdoc parser

npm run build:parser

Run the test suite:

npm test

Start the server in dev mode:

npm run dev

Now you can open http://localhost:3000 and the web app should be up and running.

Run in production

Locally

Make sure all tests pass and there's no lint errors

npm run test && npm run lint

Build the Next.js app

npm run build:next

Start the Node.js server

npm run start

With Docker

1. Install Docker on your machine.
2. Build the container: docker build -t er-docker ..
3. Run the container: docker run -p 3000:3000 er-docker.

Deploy to remote server with pm2

First make sure to add your credentials in a .env file.

Install pm2

npm install pm2 -g

Setup remote

pm2 deploy pm2.config.js production setup

Deploy

pm2 deploy pm2.config.js production