Assistant Relay is in active development, and welcomes contributions to assist with bug fixes and feature enhancements.
Contributing to Assistant Relay doesn't always involve writing code. There are many ways to get involved:
- Answering questions on GitHub or Discord
- Contributing to this documentation. (Check out Docusaurus for guides on how to edit these docs)
Join our Discord Channel
If you fancy contributing to Assistant Relay as a developer, join our #assistant-relay-development channel on Discord
Our development process
Reporting a new issue
When reporting a new issue, please make sure you fill out the provided template where possible. Filling out this template helps us look for the issue faster as the basic questions have been answered.
- One issue, one bug: One bug per issue please
- How can we replicate it: Please complete the template and list the steps to reproduce the issue
Requesting new features
Whilst feature requests are always welcomed, we can't guarantee they will be implemented. Assistant Relay is built as a non commercial, hobbyist solution and all features are built in free time.
If you wish to request a new feature, please complete the Feature Request template
Developing Assistant Relay
Assistant Relay uses Express to power the REST API and connection to the Google Assistant SDK, and React to power the web dashboard. When a new release is issued, React is bundled and included in the Express server.
IF YOU ARE NOT DEVELOPING ASSISTANT RELAY, PLEASE FOLLOW THE INSTALLATION INSTRUCTIONS UNDER GETTING STARTED INSTEAD
- Ensure that you have Node.js installed
- After cloning the repository, run
npm iin both the
- Go into the
clientdirectory and run
npm run startto start the React instance
- Go into the
relaydirectory and run
npm run devto start the Express server