This project has been built by Indigo Tree, and it's powered by SvelteKit and Cloudflare.
This is our template for new SvelteKit projects, The app itself prints a "Hello, world".
Please read carefully through this entire file (it's important!).
To be onboarded to the project, you'll need the following from Indigo Tree:
- Access to our Github organisation.
- Access to the appropriate Cloudflare account.
- Access to the project on Teamwork.
Contact the project manager and/or your developer colleagues to get access as required. You will need to enable multi-factor authentication on your accounts.
Before you begin committing code, double-check that you have the correct email address configured for this particular Git repo. It's likely that this should be your work email address instead of a personal email address.
Once you have installed dependencies with npm install
, start a development server:
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
To create a production version of the app:
npm run build
You can preview the production build with npm run preview
.
The development process mostly follows the Git Flow model. Development happens in feature branches, which are merged into develop
, which is merged into staging
for deployment to the testing environment, and then merged into main
for deployment to production.
When a pull request is opened, it will be automatically assigned to one of your colleagues for code review, after which it is your responsibility to merge into the project.
This project uses NPM for package management. NPM is used to install build tools and third-party Javascript packages.
Deployment to Cloudflare Pages is handled by a Github Action. To set this up for a new project, consult Cloudflare's documentation.
- Triggered when a change is merged into
develop
branch on Github. - Javascript quality checks are run and must pass prior to deployment.
- Github deploys the changes to Cloudflare Pages.
- Triggered when the
develop
branch is merged intostaging
on Github. - Javascript quality checks are run and must pass prior to deployment.
- Github deploys the changes to Cloudflare Pages.
- Triggered when the
staging
branch is merged intomain
on Github. - Javascript quality checks are run and must pass prior to deployment.
- Github deploys the changes to Cloudflare Pages.
The project contains only one type of automated test:
- Coding standards which are run with ESLint.
All of the test frameworks are installed with NPM as part of setup.