You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-17Lines changed: 12 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,39 +31,34 @@ Contact us on [Slack](https://slack.lyontechhub.org), at contact@lyontechhub.org
31
31
32
32
Developers
33
33
----------
34
-
This web site is done with plain HTML/CSS3/Javascript.
34
+
This website is done with [Astro](https://astro.build/) framework, using TypeScript and plain HTML/CSS/JavaScript.
35
35
36
-
The website is hosted through GitHub pages at lyontechhub.github.io as Organization pages (cf. https://help.github.com/articles/user-organization-and-project-pages).
37
-
Note that GitHub uses master branch to deploy, that's why we have 'dev' branch as the default one, which contains source code, that is compiled through Gulp and pushed to master for deployment (see below).
36
+
The website is hosted through GitHub pages at lyontechhub.github.io.
37
+
The branch `gh-pages` hosts the website.
38
38
39
39
### Source code
40
40
41
-
It is built upon Bootstrap, with LESS files for theme customisation (see Dev & build environment).
41
+
It is built upon [Astro](https://astro.build/) with TypeScript. Styles are written in plain CSS.
42
42
43
43
### JSON data & images
44
44
45
-
The following JSON files are used to provide content to dynamic views in 'data' directory:
45
+
The following JSON files are used to provide content to dynamic views :
46
46
47
-
*communities/[one per community].json
47
+
*data/[one per community].json
48
48
49
-
Images like community icons are in 'imgs' directory.
49
+
Images like community icons are in 'public/imgs/communities' directory.
50
+
51
+
* public/imgs/communities/[one per community].json
50
52
51
53
### Dev & build environment
52
54
53
-
After cloning, just type the following commands to have a :
55
+
After cloning, just type the following commands:
54
56
55
57
```
56
58
npm install
57
-
npm start
59
+
npm run dev
58
60
```
59
61
60
-
Nb : npm start is configured to start a local Node web server
61
-
62
-
Gulp is used to build assets (CSS & JS) and copy other assets (data & images) used by the site.
63
-
64
-
* 'build' task is used to build JS, CSS (from LESS) and HTML to 'public' directory ('npm start' launch 'build' task before running the local Node web server)
65
-
* 'watch' task is used to watch changes on source JS, LESS, HTML & assets files to trigger a build dynamically (never ending task)
0 commit comments