-
- User Stories: Search songs, add/remove songs to/from a playlist
-
- User Stories: Welcome/Signup/Login/Logout an account
- Additional: Accessibility report
-
- User Stories: View and manage friends list
-
- User Stories: View and manage a playlist collection
- Additional: README file
- Domain: Social Media
This program is a social media platform that allows users to connect with others through a common interest in music.
When the user opens the app, they will be prompted to either sign up for an account by creating an account with a username and password or log into their existing account. Once logged in, the user will have access to their own user profile, where a default bio is displayed. They can write a new bio, change their password, and view their friends list and playlist collection.
In a user's playlist collection, they can add or remove playlists. Opening a specific playlist displays the songs stored. The user can remove songs or add new songs using a search function. The user can also comment on the playlists of their friends.
Users will also have their own friends list, where they can add other users to this list or remove them from it. Any users that are friends will be able to view each other’s account profiles and chat with each other.
Through the welcome page, user will be prompted to log into their account if they have already created one.
User will input their username and password within the given text fields, and click Login.
Through the welcome page, user will be prompted to create a new account / sign up if they do not have an existing account.
User will be asked to input a username, and password within the given text fields. User will be required to put in the password twice for password confirmation, ensure what they've entered in is the same. User will then click the 'Sign Up' button.
Through the user's profile page, which is shown right after the login/sign up page, user's can type in a bio to talk about themselves, and provide details about their interests or anything else they would like. This feature can be accessed through the 'Edit Bio' button, which will then lead the user to the bio page where they can type in whatever they like. User must save their progress by clicking the 'Save' button.
User's will be able to create their own playlists This can be accessed through the 'Playlists' button in the user's profile view.
Once clicked, it will lead to the playlist collection page where all playlists will be displayed. User can create a playlist by clicking the 'Create Playlist' button, which will then prompt them to type in a name for the playlist in the text field provided.
User will be prompted to click the 'Save' button, or 'Cancel' if they decide they don't want to create a new playlist.
Both buttons will lead back to the playlist collection view, with the new playlist showing in the scrollPane of the playlist collection view.
User's can delete their playlists by selected a playlist they want to delete by clicking the name of the playlist listed, and click the 'Delete Playlist' button.
User's can add songs to their playlist by selecting the playlist they want songs added to, click the 'Open Playlist' button.
Then, as it leads you to the playlist's view, click 'Search Tracks'.
It will then lead you to a view where you can search for a song by its title. User will type in the song they want in the text field on the top of the page, and then click 'Search'.
After the 'Search' button has been clicked, the user will select the correct song they want within the scrollPane on the bottom of the page that's been provided by the Spotify API, and then click the 'Add Song' button.
User will be prompted to click the 'Back' button to return to the playlist and see the song they added within the playlist.
User's can remove a song in their playlist by simply selecting the song they don't want within the playlist, and then click 'Remove Track'.
User's can add other users on the Shareify app as friends in their friend list. User can access their friend list through the User Profile view, and then clicking the button 'Friends'.
User will first see an empty Friend list if they currently do not have friends, but don't worry!
To add a friend, click the 'Add Friend Button'.
Type in your friend's username in the text field and click 'Save', or the 'Back' button to cancel. Your new friend will then pop up on the Friend list!
User can delete friends from their Friend list by selecting the friend they don't want, and then clicking the 'Delete Friend' button.
User can view their friend's playlists, and their friend's friend list User can access this by selected the friend's username in the Friends List, and clicking the 'View Friend' button. In there the user can click 'View Playlists' to see the friend's playlist or click 'View Friends' to see the friends list of this friend.
Viewing a friend's playlist:
Viewing a friend's friends list:
User's can chat with their friends by selecting the friend they want to chat with on their Friends List, click 'View Friend' button, and then click the 'Send Message' button.
To send a message, type something you want to say to the other user in the text field on the bottom of the page, and then click 'Send Message'.
Message will be seen in message view above the text field.
If user exits the message page, and decides to chat with their friend another day. To get your message history, simply click the 'Refresh Message' button, and all messages will show.
If the user decided that they want to change their password, through the user's profile view, click 'Change Password'.
User will be prompted to put in a new password in the text field, and then click 'Change Password' to save this change. User can also click the 'Back' button if they change their mind.
User's can log out of their account by click the "Logout' button on their profile view.
After logging out, it will bring the user back to the welcome screen.
User's get to choose whether they like to have their user profile page in light or dark mode. To make this change, user will click 'Night Mode' or 'Light Mode' bottom on the bottom of the user profile page!
- On your github, clone the repository. This is the link of the repository on the github website: https://github.com/qinalena/Shareify
- You will then click the green '<>Code' button, and copy the HTTPS link (https://github.com/qinalena/Shareify.git).
- Open your IntelliJ, and on the welcome screen click 'Get from VCS' button on the top right, and then paste the HTTPS link in the URL text field and click 'Clone'.
- On the left panel 'Project', open the src folder -> main folder -> java folder -> app package -> run 'MainShareifyApplication'.
Now you can play around with the app, and its features!
IMPORTANT: If you would like to run the code and have access to the Spotify API, please contact @alena.qin@mail.utoronto.ca for environment variable!
Steps to add in environment variable:
- On IntelliJ, click Run -> Edit Configurations -> Insert environment variable
- Log in or create a new account on the welcome page.
- Bio
- Type in a description in the text field of the bio view, and click the save button
- Accessible through the user profile view, and clicking 'Edit Bio'.
- Playlists
- To view your playlists, click 'Playlists' on the user profile view.
- Playlists will be shown in the Playlist Collection page once opened.
- To create a playlist, click 'Create Playlist' in the Playlist Collection page, then the view will change, and you can type in a name for the playlist in the provided text field. Click 'Save' to save the name and set it for the newly created playlist.
- To delete a playlist, click on the playlist you want to delete in the Playlist Collection view, and click 'Delete Playlist'.
- To view your playlists, click 'Playlists' on the user profile view.
- Songs
- To add a song to a playlist, click the playlist you want in the Playlist Collection view, click 'Open Playlist', and then click 'Search Tracks'. Type in the song you want in the text field, click 'Search', select the correct song and click 'Add Song'. Click the 'Back' button, and you will see the song added to your playlist.
- To remove a song, select the song you want to remove in your playlist, and click 'Remove Track'.
- Friends
- To add a friend to your friend list, click 'Friends' on the user profile, click 'Add Friend' in the Friends List view, input the friend's username and click 'Save'.
- To remove a friend from your friend list, select the friend you don't want on the Friends List view, and click 'Delete Friend'.
- To view your friend's playlists, select the friend you want on the Friend List view, click 'View Friend', and in the Friend's profile view, click 'View Playlists'
- To view your friend's friend list, select the friend you want on the Friend List view, click 'View Friend', and in the Friend's profile view, click 'View Friends'
- Chat
- To message a friend, on the Friend List view, select a friend, click 'View Friend', then on the friend's profile, click 'Send Message'. You can then type a message in the text field and click 'Send Message'.
- To get message history, click 'Refresh Messages' in the Chat view
- Change password
- To change your password, on the user profile click 'Change Password', and then in the change password view, input your new password in the text field, and then click 'Change Password' to save it.
- Logout
- To log out, click the 'Logout' button on the user profile, and it will bring you back to the welcome page, successfully logging the user out.
Link to code license: LICENSE
Users have a user profile which will display basic personal information (username and bio). There are buttons that can view their friends list, playlist collection, edit their bio, change password or logout an account. If they are new users, they will have a bio "Hi! I'm new to Shareify!" by default. They can freely change their bio and save it. They could also change their password by entering the new password in the change password view. They could also switch to night mode or switch back to light mode by clicking the "night mode" button.[Team]
Users will be welcomed by the welcomed page when they run our app. From there, they can choose to signup or log in. Users can sign up for an account by inputting a username, password and repeated password. The app will show the "User already exists." to avoid repetition in usernames if the user creates a user with a username that already exists. If the repeated password they input does not match, the app will show "Passwords don't match." They could also go to login view from signup if they realize they have an account. They could log in to or log out their account. A new account starts with an empty playlist collection. [Junyu Li]
Users can create, delete, view, and manage their playlists that are stored within the playlist collection. Users will be able to see the playlists that they have created through the playlist collection view, which displays all playlists that have been created by the user. To add a new playlist, user clicks the 'create playlist' button, inputs a name of their choosing in the text field, click save, and the playlist will be shown in the playlist collection view. Users can also delete their playlist by selecting it and clicking the 'delete playlist' button. Users can open their playlists by clicking the 'open playlist' button. [Ashleigh Wong]
Users can open playlists in their playlist collection, displaying any previously added songs. Users can remove songs or add new songs using the search function, which will display the 10 most relevant songs to the query. [Alena Qin]
Users can view their friends list which is linked to their profile. Friends can be added and removed. Users can also view their friends’ account profiles. [Aseef Ali Hasan]
Users can message their friends by viewing a friend from the User's friend list, inputting a message, and sending it. Users can also view their friend's playlists and comment on them, being able to see everyone else's comments on that playlist as well. [Don Edirisinghe]
- User
- username
- password
- note
- info
- Song
- name
- artists
- Playlist
- name
- songs
- Login
- Sign up
- User Profile
- Note/Bio
- Change password
- Logout
- Playlist Collection
- Add Playlist
- Add songs
- Search for songs
- Create friend list
- Add friends
- Message friend
- Comment on friend's playlists
- Spotify Web API Java: https://github.com/spotify-web-api-java/spotify-web-api-java
-> A Java wrapper for the Spotify Web API that can access to Spotify's search track function.
User's can provide us feedback on the Shareify app by opening an issue on the repository, or you can open a discussion board and make sure to tag one of us to reach out to us.
User's can contribute to our app by forking the repository on the github website: https://github.com/qinalena/Shareify and making any changes they feel is necessary to improve the Shareify app.
To fork it, simply click the 'Fork' button, this should make a copy of the repository for you.
- Good merge request
- Provide a clear and concise description of the changes you've made
- Explain the purpose of the merge request, and why the changes are necessary
- Specify what's included and what's excluded
- Use meaningful commit messages
- Include tests (unit tests, integration tests, end-to-end tests) to verify the new functionalities
- Ensure all tests pass before submitting merge request
- Check Project's coding guidelines and ensure the code adheres to them
- Add documentation
- Make sure it's conflict free!
- Provide a clear and concise description of the changes you've made
- Protocols
- Review
- Make sure you understand the context, read the merge request descriptions and linked issues to understand the changes
- Provide actionable feedback and suggest improvements
- Focus on key areas (ex: Code correctness, performance and efficiency, test coverage, adherence to coding standards, etc.)
- Merge
- Make sure you have at least one approval of the merge request from a reviewer
- Resolve merge conflicts
- Verify all test pass
- Approve only when satisfied with quality
- Review