Skip to content

Commit

Permalink
Merge pull request #7 from knightspore/update-readme
Browse files Browse the repository at this point in the history
Chore: Update readme
  • Loading branch information
knightspore authored Jan 29, 2024
2 parents 2275c87 + 7e533db commit 5addba3
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 8 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# 💽 Selecta

![Vercel](https://vercelbadge.vercel.app/api/knightspore/selecta)

A Crate Digging Tool for DJs to get recommendations from Spotify.

![App Preview](./public/selecta.png)

## Project Structure

This is a Next 13 project, using the app router and hosted on Vercel. Currently I'm using Context Providers to handle the recommendation state in the app, and talking to the API to make Spotify calls from the server.
This is a Next 13 project, using the app router and hosted on Vercel. Currently I'm using Context to handle the recommendation state in the app, and talking to the API to make Spotify calls from the server.

### Contributing

You'll need a number of auth keys to contribute to the project (as listed in `.env.example`). A [Spotify Developer Account](https://developer.spotify.com/) is required, as well as a [Vercel KV Database](https://vercel.com/docs/storage/vercel-kv).

## Roadmap / Ideas

- `/src/app` - NextJS App
- `/src/app/api` - API Routes
- `/src/components` - Basic Components
- `/src/provider` - Recommendations / AudioPlayer Context
- `/src/lib` - Various re-usable code and Spotify library
- Add Soundcloud Support
- Better Library Interaction (ie. Manage playlists from within Selecta)
- Re-do the in-app sample player

## License

Expand Down
Binary file modified public/selecta.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/components/recommendations/SeedItemCard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export default function SeedItemCard({
}: Props) {
return (
<div className="flex items-center rounded-r gap-1 bg-shell-200">
<div className="relative flex-shrink-0 w-8 h-8">
<div className="relative flex-shrink-0 w-8 h-8 aspect-square overflow-hidden">
<img
src={img || ""}
alt={`${name} avatar`}
Expand Down
2 changes: 1 addition & 1 deletion src/components/tracks/Track.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export default function Track({ track }: Props) {
className="flex items-start cursor-pointer md:flex-col"
onClick={handleSelectTrack}
>
<div className="w-32 h-32 md:w-full md:h-auto">
<div className="w-32 h-32 md:w-full md:h-auto aspect-square">
<AlbumArt album={track.album} />
</div>
<div className="flex flex-col p-2">
Expand Down

1 comment on commit 5addba3

@vercel
Copy link

@vercel vercel bot commented on 5addba3 Jan 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.