readme.md

⚠️ This repo was superseded by our new site written in Svelte.

Studenten bilden Schüler e.V.

This repo powers the Gatsby site hosted at studenten-bilden-schueler.de. It is maintained by Janosh Riebesell (Mail, GitHub).

Studenten bilden Schüler e.V. is a student-run nonprofit initiative with chapters located in university towns all over Germany. Our mission is to provide free tutoring to refugees and children from underprivileged families.

Installation

To get this site running locally, you need git, gatsby-cli and yarn (or npm). With those installed, follow these steps:

1. Clone the repo to your machine and change into its directory.

   git clone https://github.com/sbsev/sbs-homepage
   && sbs-homepage
   && git config core.hooksPath src/utils/gitHooks
   && chmod -R u+x src/utils/gitHooks

2. Install dependencies.

   yarn

3. Copy .env.example file and rename it .env.

   cp .env.example .env

   Then open .env and insert your Contentful space ID and access token. Those are found in the settings menu of your Contentful space under 'API keys'.

4. Start the dev server.

   gatsby develop

Deployment

The easiest way to get this site published is as follows:

1. Create an account with netlify.

2. Install the netlify-cli.

3. Login to your account.

   netlify login

4. Connect your GitHub repo with your netlify account for continuous deployment.

   netlify init

5. Finally deploy the site with

   netlify deploy