Skip to content

ost-fh/Cactus

Repository files navigation

Tests Tests Frontend Docker image Backend Docker image License: MIT

Welcome to Project Cactus!

"Is my favourite UI library accessible?" - "What UI Frameworks could I choose for my project that gives me a headstart in accessibility?" These are the questions project cactus tries to answer!

Structure

The project is built on two containers:

frontend/

contains the frontend, a client for providing the website. It uses the React library

More details

backend/

contains the backend of this application. It processes the db calls and handle the authentication. It's based on the NestJs processive node framework.

More details

Hosting and Persistence

The newest production-ready release of this application is hosted by the Eastern Switzerland University of Applied Sciences (OST). In the background a mongo DB stores the test results and user profiles.

Deployment

Dev Branch Deployment Main Branch Deployment

Use of Branches

The main and dev-branches are protected. Create a feature branch and a pull request (into dev) to add changes. The main branch is only to be changed from the dev-branch.

Contribution

We appreciate your interest in contributing to our project. There are two mainly focused ways to contribute this project showed in this visualization.

All possible ways how you can contribute and the appropriate guidelines will you find in CONTRIBUTING.md

Support

Funding

Maintaining and Development

License

MIT

Copyright (c) 2022-present OST