diff --git a/README.md b/README.md index 552c15806..1fd17282a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ -Instructions (docker is required): - +## Full Deploy Instructions (docker is required): - Clone the repository: https://github.com/DamianoNaraku/jodel-react.git - Run: docker compose up -d - Go to: http://localhost:3000 + +This version includes memorec model suggestions and collaborative live editing rooms. + + +# Core functionalities version +The application is publicly accessible at [this link.](https://damianonaraku.github.io/jodel-react/build/) + +If you want to run it locally, clone this repository, [install node.js and npm](https://nodejs.org/it/download), then run the following commands with a terminal opened at project's root folder +`npm install` +`npm run start` +or +`npm install` +`npm run build`