jmarsh24 / tangocloud Goto Github PK

This is tango music streaming platform

Dockerfile 0.61% Shell 0.42% Ruby 57.59% HTML 0.94% Slim 1.97% SCSS 1.79% TypeScript 29.72% JavaScript 1.16% Go 2.73% NSIS 2.31% CSS 0.75%

music music-player tango

tangocloud's Introduction

TangoCloud

Description
Release
Built With
Repository Setup
Asset Management
Development
Testing
Linting
Deployment

This is a music streaming platform for tango.

Release

Description

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Clone the repo with this link. https://github.com/jmarsh24/tangocloud.git

Built With

Ruby on Rails 7.1.3 - The back-end framework
React Native - The front-end framework
Expo Dev - iOS and Android Deployment
Postgres - Database and caching
Docker - Deployment and containerization

Repository

Make sure the nerdgeschoss development is running correctly (https://github.com/nerdgeschoss/development-environment) and follow the usual setup steps outlined there. This will create a docker server to run the postgres database.

Then install dependencies and prepare the database with:

Make sure you have ruby version 3.2.2 up and running on your local dev environment.

In order to get the project up and running you can use bin/setup. This will create a database and install any missing packages. (This has been written for mac OS, so it may not install some dependencies...)

To start the server you can run bin/dev. This will start the worker and web processes. The server api server will be available at localhost:3000

If you need to add any secrets to the repository you can request the RAILS_MASTER_KEY from the project administrator. Once you have this key all the environment variables can be viewed/edited by running

bin/rails credentials:edit

Asset Management

This project uses Vite to manage assets. This gives us the capability to have live reload in the project.

Development

For debugger this project uses the debug gem. A breakpoint can be added in the ruby code with binding.irb or by using the alias debugger.

For future development, please consult the nerdgeschoss NUTS handbook for current developer guidelines.

Testing

This project using rspec for testing. You can run the test suite using bin/guard

Before running tests, bin/rails assets:precompile should be run, otherwise the javascript and css will not be compiled.

Be default the system tests run without a head. If you would like to enable headful browsing in system tests for debugging you can change HEADLESS=true in the .env file.

Linting

This project uses linting provided by rubocop with customization added by shimmer.

It also uses Shopify LSP to improve the editor experience.

In order to run ruby linting across the code you can run bin/rubocop -A which will try to auto correct any mistakes.

tangocloud's People

Contributors

Stargazers

Watchers

Forkers

matiasfacio

tangocloud's Issues

Music Recommendations

As a user, I want to receive music recommendations based on my listening history to discover new music.

Create a prototype for sound bar with wave like soundcloud

Run clean up on missing orchestra records. sync on songs with ids in our database, downscale workers.

create a song search

Get elasticsearch working in test

User Story: User Authentication

As a user, I want to register, log in, and log out of the app securely so that I can access personalized content.

Verify m4a files can be played on expo-av

Responsive Layout

As a developer, I want the app to have a responsive layout so that it provides a consistent experience across different devices.

create 404 page

Set up playwright GitHub actions workflow

deploy app iOS

setup expo deploy

set up search endpoint for songs

Social Integration

As a user, I want to share playlists and songs with friends and see what others are listening to enhance the social experience.

Create seeds file

Deploy react app to production

User Story: Music Player

As a user, I want to play, pause, and stop music tracks so that I can control my listening experience.

The song should not play when you first open the app.
there should be stop button which removes it from a queue
it should be available across all screens
it should link to a modal and open up the song
song should be properly formatted

Create user Authentication via GraphQL

Create appstore views

In the app store we need to have views for different screens. The image size (pxs) is very important to note here. It won't accept anything else. Once we have a design we should have an easy way to generate a folder and update these views in the future.

It's not necessary to deploy, but once we want to submit it for an app it will be necessary.

https://appstoreconnect.apple.com/apps/6476820703/appstore/ios/version/inflight

There should be pagination on the graphql endpoint
infinite scroll should work
songs should be correctly formatted
there should be a playwright test
There should be album art for each song