Skip to content

Latest commit

 

History

History
99 lines (70 loc) · 3.4 KB

README.md

File metadata and controls

99 lines (70 loc) · 3.4 KB
Raw

Gatsby

BicoccaHUB

La più grande collezione di appunti del corso di informatica degli studenti della Bicocca

🚀 Quick start

  1. Clona i sorgenti.

    Usa il comando git clone per clonare i sorgenti del sito

    # Clona la repository mediante Git
git clone https://github.com/BicoccaHUB/bicoccahub.git

  2. Intalla le dipendenze.

    Naviga nel sito e installa le dipendenze necessarie mediante NPM

    cd bicoccahub/
npm install

  3. Inizia a sviluppare.

    Avvia il server di sviluppo con il comando gatsby develop

    gatsby develop

  4. Inizia a modificare il sorgente!

    La versione in sviluppo del sito è accessible a http://localhost:8000!

    Nota: Avrai bisogno anche di un secondo link: http://localhost:8000/___graphql. È uno strumento che puoi usare per fare query sui dati. Per saperne di più, controlla questo Tutorial Gatsby.

    Apri la cartella my-default-starter con il tuo editor prefereito e modifica il file src/pages/index.js. Salva e vedrai i tuoi cambiamenti immediatamente visibili!

🧐 Come modifico il sito?

Ecco una rapido sguardo ai file e cartelle principali che trovi in un progetto Gatsby.

.
│
└┬─ src
 └┬─ data
  ├── staff.yml
  └── subjects.yml

  1. staff.yml: Questo file contiene i dati relativi alle persone che hanno contribuito, diviso in varie sezioni (coders, autori e ringraziamenti speciali)

  2. subjects.yml: Questo file contiene i dati relativi agli indirizzi degi repository contenenti gli appunti. Il file è diviso per anno e per materie. Ogni materia successivamente contiene i vari repositori (indirizzo, autore e se sono in corso di sviluppo)

🎓 Aggiunta di una repository

Come specificato nella sezione precedente, il file da modificare per aggiungere nuove repository è il file subjects.yml, che è scritto mediante la sintassi di YAML

- year: <Anno del corso>
  subjects:
    - name: <Nome del corso>
      repositories:
        - owner: <Nome utente>
          url: <L'indirizzo della repository>

Per aggiungere un nuovo repository sarà quindi sufficiente seguire lo schema sopra citato seguendo le corrette regole di spaziatura, aggiungendo un record di questo tipo:

- owner: <Il tuo nome utente>
  url: <L'indirizzo della tua nuova repository>

ottenendo quindi il seguente risultato

- year: <Anno del corso>
  subjects:
    - name: <Nome del corso>
      repositories:
        - owner: <Nome utente>
          url: <L'indirizzo della repository>
        - owner: <Il tuo nome utente>
          url: <L'indirizzo della tua nuova repository>

Prima di inviare una pull request è necessario accertarsi che il sito compili senza nessun error e possibilmente senza nessun warning.

Ulteriori guide sono disponibili all'indirizzo https://bicoccahub.netlify.com/contribuisci