This repository contains the code for the user interface (UI) including the dashboard and the infotainment system. This program is to be run on a Raspberry Pi and 2 displays simultaneously that will interact with each other.
Link to live demo: ui.teamrelectric.ca
This is a mockup of the infotainment system, containing functionality for navigation, car stats, music, climate, and more.
Ensure that you have Docker and docker-compose installed on your development computer: Docker website. Windows computers will need to use WSL2 (Windows Subsystem for Linux) as a backend following this guide.
# Clone this repo
git clone https://github.com/relectric-car-team/user-interface.git
cd user-interface
# Start development server
docker-compose upTo quit the development environment, simply press Ctrl+C and the Docker container will shut down.
Ensure that you have the standard Node.js development tools available to use and the Yarn Package Manager installed globally.
# Clone this repo
git clone https://github.com/relectric-car-team/user-interface.git
cd user-interface
# Install dependencies
yarn install
# Start development server
ionic servePull requests are welcome. Please use semantic commit messages and branch naming conventions using this guide. Private branches should be named using the semantic/name/purpose convention. For example: docs/ratik/update-readme signifies that Ratik is responsible for this documentation change and the purpose of the branch is to update the README. For major changes, please open an issue first to discuss what you would like to change. Please base all pull requests off of the main branch as they will be rebase merged. Before opening a pull request: check that there are no linter issues by running yarn run lint-check and fix all formatting using yarn run prettier-fix. The linear history requirement is enforced on main.
Please make sure to update and add tests as appropriate.
This repository is distributed under the MIT License.