🎸 TokyoScene

TokyoScene is a web application designed to help users discover and explore live music events in Tokyo. Users can search for gigs, filter by genre, and view event details on an interactive map.

Table of Contents

• Features
• Installation
• Usage
• Screenshots
• Contributing

Features

• Search for Gigs: Users can search for live music events in Tokyo.
• Filter by Genre: Users can filter events by genre.
• Interactive Map: View event locations on an interactive map.
• User Dashboard: Personalised dashboard displaying user information, favourite genres, and favourite artists.
• Spotify Integration: Users can link their Spotify account to get gig recommendations based on their top genres.
• Chatrooms: Users can join chatrooms linked to a gig and interact with other users, provided they have registered for the event.

Installation

To get started with TokyoScene, follow these steps:

1. Clone the repository:

   git clone https://github.com/88valleys/tokyoscene.git
   cd tokyoscene

2. Install dependencies:

   bundle install 
   yarn install

3. Set up the database:

   rails db:create
   rails db:migrate
   rails db:seed

4. Set up environment variables: Create a .env file in the root directory and add your environment variables:

   SPOTIFY_CLIENT_ID=your_spotify_client_id
   SPOTIFY_CLIENT_SECRET=your_spotify_client_secret
   MAPBOX_API_KEY=your_mapbox_api_key
   CLOUDINARY_URL=your_cloudinary_url

5. Start the server:

   rails server

6. Visit the application: Open your browser and go to http://localhost:3000.

Spotify Developer Account

To use the Spotify API features, you need a Spotify developer account. Follow these steps to set it up:

1. Create a Spotify Developer Account:
   • Go to the Spotify Developer Dashboard and log in with your Spotify account.
   • Create a new application to get your client_id and client_secret.
2. Set up environment variables:
   • Add your client_id and client_secret to the .env file as shown above.

Mapbox API Key

To use the interactive map features, you need a Mapbox API key. Follow these steps to set it up:

1. Create a Mapbox Account:
   • Go to the Mapbox website and sign up for an account.
   • Create a new access token to get your MAPBOX_API_KEY.
2. Set up environment variables:
   • Add your MAPBOX_API_KEY to the .env file as shown above.

Cloudinary Key

To use Cloudinary for image uploads, you need a Cloudinary URL. Follow these steps to set it up:

1. Create a Cloudinary Account:
   • Go to the Cloudinary website and sign up for an account.
   • Get your CLOUDINARY_URL from the Cloudinary dashboard.
2. Set up environment variables:
   • Add your CLOUDINARY_URL to the .env file as shown above.

Usage

Searching for Gigs

• Use the search bar to find live music events in Tokyo.
• Filter events by genre using the filter bar.
• View event details and locations on the interactive map.

User Dashboard

• View your personalised dashboard with your upcoming events.
• Link your Spotify account for gig recommendations around Tokyo based on your music taste.
• View your favorite genres and artists.

Update Band Images

Fetch and update band images using the Spotify API by running the following command:

bundle exec rake gigs:update_band_images

Screenshots

Here are some screenshots of the TokyoScene application:

Home Page

Search Results

Gig Details

Chatrooms

Chatrooms/Show

User Dashboard

Contributing

We welcome contributions to TokyoScene! To contribute, follow these steps:

1. Fork the repository: Click the "Fork" button at the top right of this page.
2. Clone your fork:

   git clone https://github.com/yourusername/tokyoscene.git
   cd tokyoscene

3. Create a new branch:

   git checkout -b feature/your-feature-name

4. Make your changes: Implement your feature or fix the bug.
5. Commit your changes:

   git add .
   git commit -m "Add your commit message"

6. Push to your fork:

   git push origin feature/your-feature-name

7. Create a pull request: Go to the original repository and click "New Pull Request".