Skip to content

Latest commit

 

History

1,306 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to DCB Admin

Welcome to DCB Admin! DCB Admin is a modern web app, built to be the administrative UI for OpenRS DCB. It's used by central office staff, consortium administrators, and support providers, and can also be used to carry out OpenRS implementations. DCB Admin is developed by Knowledge Integration and is part of the OpenRS resource sharing initiative. To get started with DCB Admin, you also need an OpenRS DCB Service running.

DCB Admin is a React application written in TypeScript. Material UI is used as the project's UI framework to deliver a dynamic, themable and resillient modern user interface. Vite is used for build tooling.

Accessibility

This project conforms to the WCAG 2.2 AA accessibilty guidelines. Users can select dark and high contrast modes from within the application settings. We also publish a VPAT for this application.

How to get started as a developer

To get started with this project, simply clone it into your IDE of choice. You will need to npm install the project's dependencies, and for development you will also need a .env file - speak to your team about this.

To see the application running, please visit https://dev.kihosting.net/dcb-admin - this is based upon the main branch.

Deployment

Looking to deploy DCB Admin? See our deployment guide.

Documentation

See developer guidance for DCB Admin documentation.

Testing

DCB Admin uses Playwright for E2E tests and Vitest for unit tests. Please refer to the DCB Admin documentation for guidance on getting started.

Contributing

Please refer to the contribution guidelines before contributing to DCB Admin.

Raising an issue

// TODO

Roadmap

// TODO

Releases

This project is released using semantic_release. See the tags section for past releases.

About

DCB Admin is a modern web application designed to help consortium staff manage their consortia's OpenRS DCB experience.

Resources

Contributing

Stars

2 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages