Skip to content

Commit 62cd89a

Browse files
Babali42blackheaven
authored andcommitted
doc: Update technical website description in readme
1 parent 4291ab4 commit 62cd89a

1 file changed

Lines changed: 12 additions & 17 deletions

File tree

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,39 +31,34 @@ Contact us on [Slack](https://slack.lyontechhub.org), at contact@lyontechhub.org
3131

3232
Developers
3333
----------
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.
3535

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.
3838

3939
### Source code
4040

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.
4242

4343
### JSON data & images
4444

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 :
4646

47-
* communities/[one per community].json
47+
* data/[one per community].json
4848

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
5052

5153
### Dev & build environment
5254

53-
After cloning, just type the following commands to have a :
55+
After cloning, just type the following commands:
5456

5557
```
5658
npm install
57-
npm start
59+
npm run dev
5860
```
5961

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)
66-
6762
### Deployment
6863

69-
Automatically deployed via github action
64+
Automatically deployed via GitHub Actions

0 commit comments

Comments
 (0)