# Skapa ett projekt för ett terminal program 
__
author: krm
created: 2018-09-09  
status: alpha
__

# 👁️‍🗨️ Om detta avsnitt

Förklarar hur vi skapar ett enkelt projekt för kursen.

# 🧭 Vad är ett projekt?

Vi skapa projekt utifrån en mall i form av en mapp med relvanta filer. 
Medtoden i mallarna tar en klar ställning ifråga om arbesflöde och 
kodningstil för att det ska var enkelt att använda dem utan att tänka 
på detaljer. Men de är lätta att modifiera om det skulle behövas. Olika 
teknologier som kommer användas:

- node
- npm
- typescript
- mocha, med chi
- typescript 

# 📚 Vad som behövs:

Du behöver ha detta installerat på din dator.

- node, vilket också kommer isntallera npm.

# 🏷 Namn som används

- 🏷 __MITT_PROJEKT__ Namnet på mitt projekt.
- 🏷 __PLATFORM__ Platform för projekt. Kan föränvarande bara vara linux.
- 🏷 __EDITOR__ Namnet på en editor för att editera små filer, t.ex. *geany*.

# 1. Klona vår samling av mallar

Dessa finns i arkivet *mimer-template*.

```sh
git clone https://gitlab.com/krmit/mimer-template.git
```

# 2. Kopiera mappen "terminal” till din utvecklar mapp 

Du ska utgå från denna i resten av projektet.

```bash
cp -r mimer-template/Project/terminal/ ./MITT_PROJEKT
```

# 3. ➕ Bestäm vilken licensens som ska användas

Bestäm vilken licens som ska användas, förslagsvis AGPL samt kopiera 
in denna i ditt projekt. Filen med licenstexten ska hetta *COPYING*. 
Läs också *README.md* filen i mimer-template där du har all 
infromation som du behöver för att fylla i licens information nedan 
på rätt sätt.

```bash
cp mimer-template/Licence/agpl-3.0.txt ./MITT_PROJEKT/COPYING
```

Om du inte väljer en licens är projektet privat och ingen annan kan 
enligt lag kopiera ditt program utan din tillåtelse.

# 4. Gå igenom projekt filen 

Läs igenom *package.json* filen och se till att den stämmer överens med 
ditt program. Till exempel:

- Skriv in ett namn på projektet.

```bash
geany package.json
````

# 5. Skriv en README.md fil där du snabbt beskriver ditt program.

```bash
geany README.md
```

# 6. Installera packet

Installera alla program med paketen.

```sh
npm install
```

## ‼️ Setup

Visa platoformat kan ha specialla setup komandon. Instället för 
komandot _install_.

```sh
npm setup:PLATFORM
```

# 7. ➕🦉 Skapa ett projekt med ditt namn på gitlab.

Vill du ha projektet i ett git arkiv följ instruktionerna nedan.

- 🦉 [Skapa ett git arkiv](./guide-to-git/create-git-repository.sv.html)