From 7a79a817e2ac099d44c30549d8a7cc057893b67a Mon Sep 17 00:00:00 2001 From: Tormi Tabor Date: Sun, 10 Mar 2024 22:18:28 +0200 Subject: [PATCH] Update readme with development instructions. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 50864cf..2c905da 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # Vanamoisa arendusala Vanamõisa külla kavandatakse mahukat kinnisvaraarendust. Vaata plaane ja materjale lähemalt aadressil [sauevald.github.io/vanamoisa](https://sauevald.github.io/vanamoisa/#15/59.3335/24.5657/o-hy-ka-va). + +## IT-lahenduse arendamine + +Käesolev repositoorium on loodud IT-lahenduse arendamiseks, mis võimaldab kuvada kinnisvaraarenduse plaane ja materjale interaktiivselt. + +### Arenduskeskkonna seadistamine + +1. Lae alla ja installeeri [Node.js](https://nodejs.org/en/download/). +2. Klooni repositoorium: `git clone git@github.com:sauevald/vanamoisa.git`. +3. Käivita käsk `npm install` repositooriumi kaustas. +4. Käivita käsk `npm start` repositooriumi kaustas. +5. Ava veebilehitsejas aadress [http://localhost:3001](http://localhost:3001). + +### Arenduskeskkonna kasutamine + +Kasuta arenduskeskkonnas tehtud muudatuste valideerimiseks käsku `npm run lint`. See kontrollib koodi stiili ja kvaliteeti vastavalt [Prettier](https://prettier.io/) reeglitele. Koodimuudatuste esitamiseks loo uus haru ja tee pull request.