The commitment of this repository is to allow all the Developer Student Clubs to generate a site for their club in less than 3 minutes, performing a few simple steps.
The management of this site does not require any kind of web development and backend competence.
You can see the demo here
To change the content of the site, go to the content
folder located in the root of the project. In this folder there are several .yaml files in which you can modify the contents.
To install you first need node.js on your machine. You need to perform the following steps only the first time.
# Clone the repo
git clone https://github.com/andreabac3/dsc-website-template.git
cd dsc-website-template/
# Install the gatbsy CLI
npm i -g gatsby-cli
# Install local dependencies
npm install
# Run on localhost:8000 (by default)
# and edit the /content folder
npm run develop
that's it!
We suggest to read the Firebase Hosting guide reference from Gatsby website
Make sure you have:
- a Firebase Account
- created a Firebase Project
Click here to read more about Firebase Deploy
You can skip the first two points of the guide if you have already installed and configured the following dependencies.
- Install the Firebase CLI with npm by running the following command and sign into firebase account:
npm install -g firebase-tools
- Sign into Firebase using your Google account by running the following command:
firebase login
- Navigate into the root of the project and running the following command:
firebase init
then select Firebase Hosting and the firebase project you wish to use or creat a new one if you haven't done it previously.
These first three steps are needed only once during the first configuration. After that, only step 4 is needed to deploy on Firebase.
- Finally we can deploy our website
npm run deployFirebase
All done! Once the deployment concludes, you can access your website using firebaseProjectId.firebaseapp.com
or firebaseProjectId.web.app
.
N.B: of course replace the keyword with the name of your project.
npm run deploy
Click here to read How to add extra icons
(for twitter, youtube, github, linkedin, you only need step 1)
Let's say I want to add the telegram.org
as telegram link in the John Doe card.
Step 0: Check here if the icon is present
Step 1: Add a telegram: telegram.org
entry in the John Doe social yaml field
Step 2: Add the following export in ./src/icons.js
:
faTelegram as telegram
Step 3: In ./src/components/index/Teams.js
, add telegram:
social {
twitter
github
linkedin
telegram
}
(for twitter, youtube, github, linkedin, you only need step 1)
Let's say I want to add the telegram.org
as telegram link in the website footer.
Step 0: Check here if the icon is present
Step 1: Add a telegram: telegram.org
entry in the siteMetadata.social field in ./gatsby-config.js
Step 2: Add the following export in ./src/icons.js
:
faTelegram as telegram
Step 3: In ./src/components/Footer.js
, add telegram:
social {
youtube
github
twitter
telegram
}
- Andrea Bacciu (DSC LEAD - Software Engineer) Github profile
- Alessandro Scandone (Core Team - Frontend developer) - Github profile
This is a refactor of the EKSU DSC website as a gatsby template.