src | ||
.eleventy.js | ||
.gitignore | ||
.prettierrc | ||
.stylelintrc.json | ||
deploy.js | ||
LICENSE.txt | ||
package-lock.json | ||
package.json | ||
README.md |
Astrolabe website
Getting started
Requirements :
- Git
- Node.js (minimum version v12.15.0)
Install
- Clone or fork this repo:
git clone https://git.ouvaton.coop/astrolabe/SiteWebAstrolabe
cd
into the project directory and runnpm install
- Once all the dependencies are installed run
npm start
- Open your browser at
http://localhost:8080
and away you go!
Deploy
- Copy paste deploy.js file in two new files
deploy-preprod.js
anddeploy-prod.js
- Make sure to fill in correct platform information in the two files
- Run
npm run deploy-preprod
to deploy to the pre-production platform - Run
npm run deploy-prod
to deploy to the production platform
Terminal commands
Serve the site locally
npm start
Build a production version of the site
npm run prod
Lint Sass
npm run sass:lint
Compile Sass
npm run sass:process
Content editing
All operations are based on the src
folder as a root.
Add a new post
A post is composed of a markdown file and optionally images.
There is two kinds of posts :
- News post
- Event post
Add a 'news' post
In the posts
folder, create a new mardown file example.md
(or copy paste one of the existing files)
Fill in the meta information :
title:
the post headingdate:
the publication date, if further than current date the post won't appear in the posts list until current date is met.type:
'news' for news post
Then add the post content in plain mardown language. You can add images to your post, make sure to place them in the images
folder.
Add an 'event' post
In the posts
folder, create a new mardown file example-date.md
(or copy paste one of the existing files). Use date in post file name to identify them easily (not mandatory).
Fill in the meta information :
title:
the post headingdate:
the publication date, if further than current date the post won't appear in the posts list until current date is met.time:
the time of the event.type:
'event' for event post
Then add the post content in plain mardown language. You can add images to your post, make sure to place them in the images
folder.
Add a new member
In the members
folder, create a new mardown file name-surname.md
(or copy paste one of the existing files)
Fill in the meta information :
name:
the full name of the memberposition:
job titlepositionInternal:
internal role if anydate:
date of arrival in the coopprofile:
picture of the member, make sure to place it in theimages/profiles/
folderpersonalSite:
website url if anysocialMastodon:
profile url if anysocialTwitter:
profile url if anysocialLinkedin:
profile url if anyurl:
personal page url in the website, eg/members/name-surname
Then add the member bio or any content
Customers & Partners
The two are listed on the home page in different section. There is maximum of four per section, in reversed order regarding the date of addition.
Add a new customer
In the customers
folder, create a new mardown file customer-name.md
(or copy paste one of the existing files)
Fill in the meta information :
name:
the brand name of the customerthumbnail:
the customer brand logo, make sure to place it in theimages/customers/
folderurl:
the customer website
Add a new partner
In the partners
folder, create a new mardown file partner-name.md
(or copy paste one of the existing files)
Fill in the meta information :
name:
the brand name of the partnerthumbnail:
the partner brand logo, make sure to place it in theimages/partner/
folderurl:
the partner website