School Improvement Programme - School Profiles (working title)

A WIP project

View · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

TBC

Environment	Internal URL	Public URL	Status
Production	https://sap-public-production.teacherservices.cloud	https://beta.schoolprofiles.education.gov.uk
Test	https://sap-public-test.test.teacherservices.cloud	https://test.schoolprofiles.education.gov.uk

(back to top)

Built With

(back to top)

Prerequisites

• .NET 8.0 SDK
• Node.js 22.x (for building frontend assets)
• Docker Desktop (optional, for containerized development)
• Visual Studio 2022 or Visual Studio Code (recommended)

Getting Started

1. Clone the repository

git clone https://github.com/DFE-Digital/sap-public.git
cd sap-public

2. Install .NET dependencies

dotnet restore

3. Install Node.js dependencies (for frontend assets)

cd SAPPub.Web
npm install
cd ..

The npm install command automatically runs a postinstall script that copies GOV.UK Frontend and required libraries from node_modules to wwwroot/lib/.

Running Locally

Option 1: Using .NET CLI

cd SAPPub.Web
dotnet run

The application will be available at http://localhost:3000

Option 2: Using Visual Studio

1. Open sap-public.sln in Visual Studio
2. Press F5 to run with debugging (or Ctrl+F5 without debugging)
3. The application will launch in your default browser

Option 3: Using VS Code

1. Open the project folder in VS Code
2. Press F5 to start debugging
3. Select ".NET Core Launch (web)" configuration
4. Navigate to http://localhost:3000

Running with Docker

Build the Docker image

docker build -t sappub:latest .

The Docker build process:

1. Assets stage: Builds frontend assets using Node.js
2. Build stage: Compiles .NET application
3. Final stage: Creates minimal runtime image

Run the container

docker run -p 3000:3000 sappub:latest

The application will be available at http://localhost:3000

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/DFE-Digital/sap-public

(back to top)