Chorls App User Guide
Welcome to the Chorls App! This guide will help you navigate and use the app effectively.
Table of Contents
- Add Score Screen
- View Sets List
- View Performance Details
- User Details
- Upload Scores
- Updates
- Settings
- Score Details
- Reset Password
- Register
- Profile
- Ensemble page
- Not Found
- Login
- Library Search
- Join Ensemble
- Intro Screen
- Home
- Forgot Password
- Edit Set
- Delete Account
- Add Set
Add Score Screen
The Add Score Screen allows users to add new scores to their ensemble library. Users can input details such as:
- Library Number: A unique identifier for the score.
- Title: The name of the score.
- Composer: The composer of the score.
- Arranger: The arranger of the score (if applicable).
- Instruments: Specify the instruments or voice types required for the score.
- Number of Copies: The total number of copies available.
- Number of Originals: The number of original copies available.
- Tags: Keywords to help categorize the score.
- Section: The section or category the score belongs to (e.g., Classical, Jazz).
Once saved, the score is added to the library for future use.
View Sets List
This screen displays a list of sets (collections of scores) for the user to browse. Users can:
- Search for specific sets using the search bar.
- Tap on a set to view its details.
- Navigate to the "Add Set" screen to create a new set.
View Performance Details
Displays detailed information about a specific set, including:
- The set's name and performance date.
- A list of scores included in the set.
- A list of performers assigned to the set.
Users can edit or manage the set if they are the owner.
User Details
Shows detailed information about a specific user, including:
- Their name, title, and contact information.
- A list of instruments they play.
Upload Scores
Allows users to upload multiple scores via a CSV file. Users can:
- Select a CSV file from their device.
- Map CSV columns to the app's fields (e.g., Title, Composer).
- Upload the data to the library in bulk.
Updates
Displays updates or announcements for the app, such as new features or bug fixes.
Settings
Allows users to configure app settings, such as:
- Notification preferences.
- Theme settings (e.g., light or dark mode).
Score Details
Displays detailed information about a specific score, including:
- The score's title, composer, arranger, and library number.
- The number of copies and originals available.
- The instruments and tags associated with the score.
Users can edit or delete the score if they have the necessary permissions.
Reset Password
Allows users to reset their password using a reset token. Users need to:
- Enter the reset token sent to their email.
- Enter a new password.
- Submit the form to update their password.
Register
Enables new users to create an account by providing their details, such as:
- Username
- Password
- First and last name
- Instruments they play
Profile
Displays and allows editing of the user's profile, including:
- Name, email, and phone number.
- Instruments they play.
- Profile picture.
Ensemble page
Displays details about the user's ensemble, including:
- The ensemble's name and type.
- A list of members and their roles.
- Options to manage members (e.g., promote to admin, remove).
Not Found
Displays a 404 error for undefined routes. Users can navigate back to the home screen.
Login
Allows users to log in to their account using their email and password. If they forget their password, they can navigate to the "Forgot Password" screen.
Library Search
Allows users to search for scores in the library using various filters, such as:
- Title
- Composer
- Tags
Join Ensemble
Allows users to join an ensemble using an invite code provided by the ensemble owner.
Intro Screen
Serves as the app's welcome screen, providing options to log in or register.
Home
Serves as the app's main dashboard, providing quick access to key features.
Forgot Password
Allows users to request a password reset email by entering their registered email address.
Edit Set
Allows users to edit an existing set, including:
- Changing the set's name and performance date.
- Adding or removing scores and performers.
Delete Account
Allows users to delete their account and all associated data. This action is irreversible.
Add Set
Allows users to create a new set by:
- Providing a name and performance date.
- Adding scores and performers to the set.
Frequently Asked Questions (FAQ)
How do I add a new score?
Navigate to the Add Score Screen, fill in the required details (e.g., title, composer, instruments), and click "Save Score." The score will be added to your ensemble library.
How do I reset my password?
Go to the Reset Password Screen, enter the reset token sent to your email, and provide a new password. Submit the form to update your password.
Can I upload multiple scores at once?
Yes, use the Upload Scores Screen to upload a CSV file containing multiple scores. Map the CSV columns to the app's fields and submit the data.
How do I join an ensemble?
Navigate to the Join Ensemble Screen and enter the invite code provided by the ensemble owner. Once submitted, you will be added to the ensemble.
What happens if I delete my account?
Deleting your account will remove all your data from our servers, including scores, sets, and profile information. This action is irreversible.