The SWEET Project: Providing protection, safeguarding, empowerment, problem-solving skills and support.
Professor Linda Sharp (linda.sharp@ncl.ac.uk)
Professor Eila Watson, Oxford Brookes University(ewatson@brookes.ac.uk)
Mark Turner
RSE Team
Newcastle University
(mark.turner@newcastle.ac.uk)
This project is built with Jekyll and Tailwind CSS
This is the repository for The SWEET Project. The majority of data that's being displayed on the website can be edited using the "data.yml" file.
brew install chruby ruby-install
.ruby-install --latest ruby
.source /usr/local/share/chruby/chruby.sh
to your shell of choice. If you are using macOS, add these lines source /opt/homebrew/opt/chruby/share/chruby/chruby.sh source
/opt/homebrew/opt/chruby/share/chruby/auto.sh
to your shell of choice. If you're using bash, it should be ~/.bash_profile (or ~/.bashrc on some systems). If you're using zsh, it should be ~/.zshrc. Save changes and restart the terminal. These just enable chruby commands to be run in your shell.ls /opt/homebrew/opt/chruby/share/chruby/chruby.sh ls /opt/homebrew/opt/chruby/share/chruby/auto.sh
to check these lines exist.chruby 3.2.2
, else skip this step. 3.2.2 is the latest stable release at the time of writing this and the version of ruby that was installed during step 3. You can check it's the most up to date release here or by running ruby-install -U
. Just replace 3.2.2 with the version that was installed during step 3.gem install jekyll bundler
.bundle install
.bundle exec jekyll serve
to start the project locally at locahost:4000.data.yml file can be located inside _data folder. The complete path is : _data/data.yml
data.yml file have different contents that when changed, will update the live website to reflect the changes. Currently, the following content can be edited and updated:
Hero Section: This is first section of the page. Usually gives a high level introduction about the project. This section has a heading, a small paragraph right below the heading and the text that should appear on the button.
Team Members: Information about the team members. Each team member includes data regarding
name title affiliation imageUrl blurb
About the Project
Workstreams: Each workstream have the following information
name title description
Public Involvement: Public involvement section has the following data
name title blurb img
Contact Us
The file can be found by clicking on _data and then clicking on data.yml file
Once file is open in github, Click on the edit icon on the right hand side. The file should now be editable.
Make the necessary changes.
Click on the green highlighted button Commit Changes and a popup should appear with the fields commit message and extended description.
The commit message field is a short description for describing the changes in the file. For example, if the contact information is edited, an appropriate commmit message would be "Edited the contact information"
Click on commit changes. The website should now be updated. It usually takes ~5 minutes for the changes to go live.
Any tools or versions of languages needed to run code. For example specific Python or Node versions. Minimum hardware requirements also go here.
How to build or install the applcation.
How to run the application on your local system.
How to run tests on your local system.
Deploying to a production style setup but on the local system. Examples of this would include venv
, anaconda
, Docker
or minikube
.
Deploying to the production system. Examples of this would include cloud, HPC or virtual machine.
Any links to production environment, video demos and screenshots.
Protected and can only be pushed to via pull requests. Should be considered stable and a representation of production code.
Should be considered fragile, code should compile and run but features may be prone to errors.
A branch per feature being worked on.
https://nvie.com/posts/a-successful-git-branching-model/
Please cite the associated papers for this work if you use this code:
@article{xxx2023paper,
title={Title},
author={Author},
journal={arXiv},
year={2023}
}
This work was funded by a grant from the UK Research Councils, EPSRC grant ref. EP/L012345/1, “Example project title, please update”.