Files
koodiklinikka.fi/README.md
Daniel Schildt 87f45af570 docs: improve readability (#63)
- Improve readability of the documentation
- Improve Markdown consistency
- Add more headings to clarify the document structure
- Add syntax types to code blocks to improve Markdown rendering
- Add mention that Git is required as a system wide dependency
2020-01-23 19:29:59 +02:00

1.7 KiB

Koodiklinikka

Travis

Koodiklinikka-logo

Koodiklinikka.fi lähdekoodi. Issueita ja Pull Requestejä otetaan lämpimästi vastaan. Yritämme pitää kynnyksen kontribuoida projektiin alhaisena, jotta mahdollisimman moni pääsisi jättämään siihen jälkensä. Kaikki koodi katselmoidaan läpi ja mergetään projektiin kun näyttää hyvälle. Muutamasta mergetystä Pull Requestista oikeudet ylläpitää projektia.

Issueita voidaan käyttää myös sivun:

  • toiminnallisuuteen
  • designiin
  • HTTP-rajapintaan
  • projektin hallintaan liittyviin asioihin
  • tai koko Koodiklinikkaan yleisesti.

Projektin asennus

Vaaditut työkalut

  • Asenna Node.js
  • Asenna Git client lähdekoodin hallintaan

Kloonaa projekti koneellesi

git clone https://github.com/koodiklinikka/koodiklinikka.fi.git

Käynnistä kehitystila

cd koodiklinikka.fi
npm install
npm start

Avaa esikatselu selaimessa

Avaa selaimessasi: http://localhost:3000

Komennot

npm install

Asentaa projektin riippuvuudet

npm start

Kääntää lähdetiedostot ja palvelee sovellusta porttiin 3000

npm run build

Kääntää lähdetiedostot -> out/ -hakemistoon