pupilfirst/pupilfirst

View on GitHub
docs/users/school_customization.md

Summary

Maintainability
Test Coverage
---
id: school_customization
title: School Customization
sidebar_label: School Customization
---

Pupilfirst is [white-labeled](https://en.wikipedia.org/wiki/White-label_product) - this means that you can alter the branding and many other aspects of the school to present a customized appearance to your students. The school customization interface allows you to tweak these aspects as per your preferences, and offers a preview of the changes you've made in different settings.

![School Customization Page - 1](../assets/school_customization/school-customize-1_zc1rzw.png)
![School Customization Page - 2](../assets/school_customization/school-customize-2_nlft1z.png)

Here's a list of things you can edit:

1. **School Details:**

   - School name
   - About: Text for hero banner in school landing page

2. **Images:** Please try to upload images with a transparent background, when possible.

   - Logo on a light background: In the header, and elsewhere with a light background.
   - Icon: Will be displayed in places like the browser's _favicon_, error pages, etc.
   - Cover image: the hero image for school landing page

3. **Links:**

   - In the header: These will be placed in the header after required links, and will be visible to the public.
   - In the footer: These will be placed in the footer after the link to the _Home_ page, and will be visible to the public.
   - Social media: You can add a list of social media links that will be automatically converted to icons placed in the footer.

4. **User Agreements:** You can create a custom _Privacy Policy_ and _Terms & Conditions_ and _Code of Conduct_ for your school. These will be displayed in the footer, and will be visible to the public.

5. **Contact Details:**

   - Your physical address, to display in the footer.
   - An email address - Besides being displayed, this will be used in all external emails as the `reply-to`.