Standard Project

A template repo for the standard RSE project

About

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed sollicitudin ante at eleifend eleifend. Sed non vestibulum nisi. Aliquam vel condimentum quam. Donec fringilla et purus at auctor. Praesent euismod vitae metus non consectetur. Sed interdum aliquet nisl at efficitur. Nulla urna quam, gravida eget elementum eget, mattis nec tortor. Fusce ut neque tellus. Integer at magna feugiat lacus porta posuere eget vitae metus.

Curabitur a tempus arcu. Maecenas blandit risus quam, quis convallis justo pretium in. Suspendisse rutrum, elit at venenatis cursus, dolor ligula iaculis dui, ut dignissim enim justo at ligula. Donec interdum dignissim egestas. Nullam nec ultrices enim. Nam quis arcu tincidunt, auctor purus sit amet, aliquam libero. Fusce rhoncus lectus ac imperdiet varius. Sed gravida urna eros, ac luctus justo condimentum nec. Integer ultrices nibh in neque sagittis, at pretium erat pretium. Praesent feugiat purus id iaculis laoreet. Proin in tellus tristique, congue ante in, sodales quam. Sed imperdiet est tortor, eget vestibulum tortor pulvinar volutpat. In et pretium nisl.

Project Team

Sam Oldham, Newcastle University (s.l.oldham1@newcastle.ac.uk)
Mark Turner, Newcastle University (mark.turner@newcastle.ac.uk)

RSE Contact

Sam Oldham
RSE Team
Newcastle University
(s.l.oldham1@newcastle.ac.uk)

Built With

React
Strapi

Getting Started

Prerequisites

Any tools or versions of languages needed to run code. For example specific Python or Node versions. Minimum hardware requirements also go here.

Installation

How to build or install the applcation.

Running Locally

How to run the application on your local system.

Running Tests

How to run tests on your local system.

Deployment

Local

Deploying to a production style setup but on the local system. Examples of this would include venv, anaconda, Docker or minikube.

Production

Deploying to the production system. Examples of this would include cloud, HPC or virtual machine.

Usage

Any links to production environment, video demos and screenshots.

Roadmap

Initial Research
Minimum viable product <-- You are Here
Alpha Release
Feature-Complete Release

Contributing

Main Branch

Protected and can only be pushed to via pull requests. Should be considered stable and a representation of production code.

Dev Branch

Should be considered fragile, code should compile and run but features may be prone to errors.

Feature Branches

A branch per feature being worked on.

https://nvie.com/posts/a-successful-git-branching-model/

License

Citiation

Please cite the associated papers for this work if you use this code:

@article{xxx2021paper,
  title={Title},
  author={Author},
  journal={arXiv},
  year={2021}
}

Acknowledgements

This work was funded by a grant from the UK Research Councils, EPSRC grant ref. EP/L012345/1, “Example project title, please update”.

reeceawalsh/Open-Research-App