Skip to content

auralous/auralous

Repository files navigation

Auralous

Music is always better when we listen together

Auralous is a free project that lets you play & listen to music in sync with friends in group sessions.

Auralous currently supports streaming music on YouTube and Spotify. We hope to add support for Apple Music soon.

CI PRs Welcome

Website: auralous.com

Structure

Codebase Description
web React Native Web app
mobile React Native app for Android and iOS
app The shared main app
api GraphQL API / URQL code, hooks, and exchanges

Workflows

package.json contains the several scripts in the workspace root.

yarn dev

Start the file watcher to build types and codegen for the project for uses in both web and mobile. You only need run it for two purposes:

  • type checking during development
  • run codegen when schema changes

yarn lint

Run yarn lint to check for errors in source code using eslint and apply formatting with prettier. You can also run yarn lint --fix to let eslint fixed the errors automatically.

Contribution

See CONTRIBUTING.md.

Acknowledgements

This project is not possible without:

  • All the OSS libraries and their maintainers
  • Odesli API for cross-playing functionality
  • last but not least... you