Skip to content
This repository was archived by the owner on Jan 9, 2023. It is now read-only.

Commit 0de985e

Browse files
committed
README: add installation instruction
1 parent 5f0b253 commit 0de985e

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,29 @@ A simple template for website created with Express JS.
44

55
This template use the Express package from Node.js and offers to start working with an organized project wich contains everything you need without useless assets.
66

7-
## Actual content
8-
7+
## Installation
8+
Do this commands by replacing ``projectName`` with the name of your project :
9+
```sh
10+
npx degit https://github.com/Leepo-Team/Express-Template projectName
11+
cd projectName
12+
```
13+
14+
Then install the packages :
15+
```sh
16+
npm install
17+
```
18+
19+
You can then launch the site in development mode with the command :
20+
```sh
21+
npm run dev
22+
```
23+
24+
Or in production mode :
25+
```sh
26+
npm run start
27+
```
28+
29+
## Organization and additional content
930
- Support for cookies and sessions.
1031
- "public" folder wich will contain everything the visitor has to download: pictures, fonts, scripts, stylesheets...
1132
- Simple routes system.

0 commit comments

Comments
 (0)