StudyTutors

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

This site is built with Svelte and Contentful.

Setup

Running this site locally requires git and pnpm (or npm). With those installed, do:

1. Clone the repo and change into its directory.

   git clone https://github.com/sbsev/site st-site && cd st-site
   

2. (optional) Setup pre-commit hooks.

   pre-commit install
   

3. Install dependencies.

   pnpm install
   

4. Copy .env.example to .env.

   cp .env.example .env
   

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

5. Start the dev server.

   pnpm dev
   

Deploy

To publish this site to netlify:

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. Create a production build.

   pnpm export
   

6. Finally deploy the site with

   netlify deploy