Litefy

Support

If you wish to support the me (mathkruger), buy me a coffee!

Table of Contents

1. Project Description
2. Project Technologies
3. Running the Application
   1. Starting a Development Server
   2. Creating a Build
4. Contribution Instructions
   1. Initial Project Setup
   2. Making Changes to the Application
      1. Generating Code Scaffolding
   3. Submitting Your Changes
5. Current Issues
6. License

Project Description

Litefy is a lightweight version of the Spotify client that is made for memory and processing restricted smartphone and computer users.

(Note: Some operating systems, such as KaiOS, are not yet supported).

To see the current deployment of the application, visit https://mathkruger.github.io/litefy.

Project Technologies

The project is being designed with the following technologies:

Angular 10
Node.js
Spotify API
Web Playback SDK

Running the Application

After you've completed the initial project setup, use the following commands to start the application.

1. Install Node.js
2. Within the litefly directory, run the command npm install to install the appropriate node modules

Starting a Development Server

1. Run the command ng serve
2. Navigate to http://localhost:4200/ to see your local version of the site

The application will automatically reload if you change any of the source files.

Creating a Build

1. Run the command ng build

The build artifacts will be stored in the dist/ directory.
For a production build, use the command ng build --prod instead.

Contribution Instructions

Initial Project Setup

1. Create a fork of the main repo to your GitHub account
2. Create a new folder somewhere on your device
3. Launch a command terminal and change your directory to the newly created folder
4. Run the command https://github.com/yourGitHubName/litefy.git
    (NOTE: Replace yourGitHubName with your GitHub username (e.g. mathkruger))
5. Open the newly created litefly folder with your IDE of choice (such as Visual Studio Code)
6. From the IDE's terminal, run the command git checkout -b your-new-branch-name to create and switch to your new branch

Making Changes to the Application

For a beginner's guide to Angular, visit Angular's tutorial page or its getting started page.
To find out more about other Angular command line instructions, visit this link.
To find out more about the Spotify API and Web Playback SDK, see their respecitve pages under the project technologies tab.

Generating Code Scaffolding

1. Run the command ng generate component component-name in the appropriate project directory to generate a new component

ng generate directive|pipe|service|class|guard|interface|enum|module can be used to generate various other file schematics.
More information on the ng generate command can be found here.

Submitting Your Changes

1. On your IDE's command terminal, run the command git add . to stage all your changes
2. Run the command git commit -m "" to commit your changes. Within the double quotations, include a brief statement that reflects what changes you made (e.g. git commit -m "fix: fixed routing bug in app-routing.module.ts")
3. Run the command git push to push your changes to your remote branch on GitHub
4. On your forked repository's GitHub page, click on the Pull Requests tab followed by the green New pull request button
5. Compare the branch with your changes to mathkruger's main branch
6. Add a brief message to your pull request that reflects the changes you made (e.g. step 2) and add more details about the changes in the description box
7. Submit your pull request for review

Current Issues

Click here to see Litefy's issues that need fixing.

License

Litefy is MIT licensed.