Commit 12d3d0ef by Linnea Samila

Reformatting readme

1 parent 7a15c49e
...@@ -54,7 +54,7 @@ ...@@ -54,7 +54,7 @@
} }
}, },
"defaults": { "defaults": {
"styleExt": "css", "styleExt": "scss",
"component": {} "component": {}
} }
} }
# Moya Angular Frontend
## Requirements
* You need `nodejs` installed.
* Installing and using `nvm` can be helpful. You can install and update node with nvm.
# devausnoteja (tmp ohjeet) ## Run only Angular part of the project
## Devaus 1. `npm install`
2. `npm run`
3. Open `http://localhost:4200/login` on your browser.
## Development
### devaus workflow ### Naming
* Write everything in English, no Finglish allowed.
* Use moya prefix for all components/directives/pipes. Components generated with angular-cli automatically add this prefix.
Examples:
* moya-info
* moya-menu
### Workflow
Kehittäminen on nopeampaa jos saa muutokset suoraan käyttöön, tämän takia kannattaa käynnistää lasikala ja webback-palvelin erikseen, ja proxyttää webbakista moya-jutut lasikalaan. Kehittäminen on nopeampaa jos saa muutokset suoraan käyttöön, tämän takia kannattaa käynnistää lasikala ja webback-palvelin erikseen, ja proxyttää webbakista moya-jutut lasikalaan.
ng-palvelimessa on bugi, ja se ei osaa jakaa tavaraa muusta hakemistosta kuin /. ng-palvelimessa on bugi, ja se ei osaa jakaa tavaraa muusta hakemistosta kuin /.
moyaproxy.conf.json sisältää proxyasetukset localhostin porttiin 8080. moyaproxy.conf.json sisältää proxyasetukset localhostin porttiin 8080.
Käyttö: Käyttö:
`npm run start` `npm run start`
...@@ -24,72 +40,87 @@ Tämän jälkeen kirjaa selaimesi sisään moyaan: http://localhost:4200/MoyaWeb ...@@ -24,72 +40,87 @@ Tämän jälkeen kirjaa selaimesi sisään moyaan: http://localhost:4200/MoyaWeb
HMR -asetukset löytyy, niistä ei nykyisellään ole mitään hyötyä. Saa poistaa. HMR -asetukset löytyy, niistä ei nykyisellään ole mitään hyötyä. Saa poistaa.
## Koodijuttuja ## Code
### moya-rest ### Moya-REST
Oma moduulinsa, joka tullaan jossain vaiheessa eriyttämään ja käyttämään myös mahdollisessa nativescript-kännyappiksessa. Eli sen alle tulee vain servisejä, ei komponentteja. Oma moduulinsa, joka tullaan jossain vaiheessa eriyttämään ja käyttämään myös mahdollisessa nativescript-kännyappiksessa. Eli sen alle tulee vain servisejä, ei komponentteja.
### Muuta ### Muuta
Jos tulee muita järkeviä kokonaisuuksia, joita voi käyttää muualla, jaa omaan moduuliinsa. Jos tulee muita järkeviä kokonaisuuksia, joita voi käyttää muualla, jaa omaan moduuliinsa.
## Hakemistohierarkia ## Directory structure
Älykäs komponentti: Älykäs komponentti:
* app <pre>
* pages `tämän alla on käytännössä "älykkäät" komponentit (stateful), eli componentit jotka tietää mitä dataa haetaan ja mistä. Käytännössä route -targetit` - app
* user `Loppukäyttäjälle näkyvät jutut, ohjleman ns. main moduuli` - pages | "älykkäät" komponentit (stateful), eli componentit jotka
* pizzatilaus | tietää mitä dataa haetaan ja mistä. Käytännössä route
* listOpen.component.ts `avoimet pizzatilaukset joista voi tilata` | -targetit
* own_orders.component.ts - user | Loppukäyttäjälle näkyvät jutut, ohjleman ns. main moduuli
* testit yms. - pizzatilaus
* admin `moya asetukset, esim. tuotteet, korttipohjat, oma moduulinsa joka lazyloadataan` - listOpen.component.ts | avoimet pizzatilaukset joista voi
* admin.module.ts | tilata
* pizzatilaus - own_orders.component.ts
* pizzaedit.component.ts `hallitse mitä pizzoja voi tilata ylipäätänsä` - testit yms.
* info `tapahtumanaikana "infolaisen" toimesta tehtävät jutut, sisäänotto, käyttäjänhallinta jne. Oma moduulinsa joka lazyloadataan` - admin | moya asetukset, esim. tuotteet, korttipohjat, oma
* info.module.ts | moduulinsa joka lazyloadataan
* viplist - admin.module.ts
* viplist.component.ts,html,jne - pizzatilaus
* viplist.service.ts - pizzaedit.component.ts | hallitse mitä pizzoja voi tilata
* pizzatilaus - info | tapahtumanaikana "infolaisen" toimesta tehtävät jutut,
* list.component.ts `listaa kaikki, ja lisää uusi pizzailaus` | ylipäätänsä sisäänotto, käyttäjänhallinta jne. Oma
* old-moya `Monessa paikassa käytettävät target -componentit tulevat omiksi kokonaisuudiksiin` | moduulinsa joka lazyloadataan
* old-moya.component.ts - info.module.ts
* pizzatilaus `Jos halutaan lazyloadata jokin osa moyasta, tehdään siitä uusi päätason komponentti. Joka sitten laitetetaan user / admin yms. puolille route -targetiksi` - viplist
* pizzatilaus-route.module.ts - viplist.component.ts,html,jne
* pizza-user-order.component.ts - viplist.service.ts
* menu `menu on täällä` - pizzatilaus
* shared `geneeriset, mihinkään osaan kuulumattomat jaetut modellit ja servicet tulevat tänne` - list.component.ts | listaa kaikki, ja lisää uusi pizzailaus
* models - old-moya | Monessa paikassa käytettävät target -componentit
* user.model.ts | tulevat omiksi kokonaisuudiksiin
* services - old-moya.component.ts
* moya-rest.service.ts - pizzatilaus | Jos halutaan lazyloadata jokin osa moyasta, tehdään
* session.service.ts | siitä uusi päätason komponentti. Joka sitten
* widgets `tyhmät componponentit tulevat tänne` | laitetetaan user / admin yms. puolille route
* button | -targetiksi
* html - pizzatilaus-route.module.ts
* ts - pizza-user-order.component.ts
* scss - menu | menu
* components `servicet sekä componenttien geneeriset tyhmät osat tulevat tämän hakemiston alle. Tänne voi myös pistää älykkäitä pieniä komponentteja ` - shared | geneeriset, mihinkään osaan kuulumattomat jaetut modellit
* viplist | ja servicet tulevat tänne
* list.component.ts - models
* add.component.ts - user.model.ts
* moya-locale - services
* moya-locale.service.ts - moya-rest.service.ts
* moya-locale.model.ts `model -tiedosto joka on käytössä vaan moya-locale -servicessä` - session.service.ts
* modules `Kokonaiset, monessa paikassa olevat kokonaisuuksien tyhmät osat tulevat tänne. Sen verta isot että ne kannattaa tehdä moduuleiksi` - widgets | tyhmät componponentit tulevat tänne
* pizzatilaus - button
* anna-pizza.component.ts - html
* list-pizzat.component.ts,html,jne - ts
* listItem.component.ts - scss
* edit.component.ts - components | servicet sekä componenttien geneeriset tyhmät osat
* pizzatilaus.service.ts | tulevat tämän hakemiston alle. Tänne voi myös
* pizza-tilaus.module.ts | pistää älykkäitä pieniä komponentteja
- viplist
- list.component.ts
- add.component.ts
- moya-locale
- moya-locale.service.ts
- moya-locale.model.ts | model -tiedosto joka on käytössä vaan
| moya-locale -servicessä
- modules | Kokonaiset, monessa paikassa olevat kokonaisuuksien
| tyhmät osat tulevat tänne. Sen verta isot että ne
| kannattaa tehdä moduuleiksi
- pizzatilaus
- anna-pizza.component.ts
- list-pizzat.component.ts,*
- listItem.component.ts
- edit.component.ts
- pizzatilaus.service.ts
- pizza-tilaus.module.ts
</pre>
## I18N & Localization ## I18N & Localization
...@@ -118,11 +149,9 @@ Integraatio jne. testit, aloitteliat ei riko asioita niin todennäköisesti. ...@@ -118,11 +149,9 @@ Integraatio jne. testit, aloitteliat ei riko asioita niin todennäköisesti.
### WebPack ja buildin minimointi ### WebPack ja buildin minimointi
aot-kääntäminen ja siihen comperssointia jne. aot-kääntäminen ja siihen comperssointia jne.
----
# MoyaAngular, auto generated instructions
# MoyaAngular, generoidut ohjeet
This project was generated with [angular-cli](https://github.com/angular/angular-cli) version 1.0.0-beta.24. This project was generated with [angular-cli](https://github.com/angular/angular-cli) version 1.0.0-beta.24.
......
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!