Skip to content
generated from andrelouw/app-template

A small music browsing app, showcasing modular and clean architecture

License

Notifications You must be signed in to change notification settings

andrelouw/shawty

Repository files navigation

CI-macOS CI-iOS Tuist badge

Shawty

A sample music app to search for artists and browse albums and tracks for that artist.

Getting started

To get started you have 2 options, light or hardcore, choose an option below:

Light

Assuming that you have Xcode installed, open the Shawty.xcworkspace file, which will load the whole project in Xcode.

Choose the iOS target and start browsing 🔍.

Normally .xcworkspace and .xcodeproj files will be git-ignored, but for the purposes of this exercise it was committed as an alternate solution to view the project.


Hardcore Run the following command in root of the cloned repository:
make

The make command will set up the dev environment, generate and build the workspace, and finally launch Xcode with the generated workspace.

Choose the iOS target and start browsing 🔍.

See the unbootstrap command that will reverse all installations done by make.


Features

The app has the following features, and detailed breakdown of each can be found on the respective page:

App Architecture

See the following pages for more information on the app Architecture:

Break down of work done

See the closed PRs for a detailed break-down of the work done

Behind the name

The name was inspired by the song Replay from Iyaz:

" Shawty's like a melody in my head
That I can't keep out, got me singin' like
Na na na na everyday
It's like my iPod's stuck on replay
Replay-ay-ay-ay
"

Other details

This (personal and still very much under development) App template was used as a starting point for this project.

See the Commands page for a full list of make commands.

See the Tools page for all the tools used in this project.

About

A small music browsing app, showcasing modular and clean architecture

Topics

Resources

License

Stars

Watchers

Forks

Languages