Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!-- Copilot instructions for contributors and AI agents working on L-square-QTify -->

# L-square-QTify — AI Agent Instructions

This repository contains a Create React App based frontend located inside the `qtify/` folder. The instructions below are concise, actionable, and specific to patterns and files actually used in this project.

- **Project root**: The runnable app lives in `qtify/` (run commands there).
- **Start locally**: `cd qtify` then `npm start` (CRA dev server).
- **Build**: `cd qtify` then `npm run build`.
- **Tests**: `cd qtify` then `npm test` (uses CRA test runner).

**Big picture / architecture**

- **Single-page React app (Create React App)**: code under `qtify/src/` — entry is `qtify/src/index.js` and main component `qtify/src/App.js`.
- **Component structure**: UI components are organised under `qtify/src/Components/<Name>/` with the component file and a CSS module (e.g., `Navbar/Navbar.jsx` + `Navbar.module.css`). Follow this pattern for new components.
- **Styling**: CSS Modules are used (`*.module.css`) alongside global `index.css` and `App.css`.
- **State / routing**: `react-router-dom` is used for navigation; examples: `Navbar` + `Search` use `useNavigate` to route to `/album/{slug}`.
- **UI library**: Material UI v7 is used (`@mui/material`, `@mui/system`) and `@mui/icons-material`.

**Important files / places to inspect**

- `qtify/package.json` — project dependencies and scripts.
- `qtify/src/Components/Search/Search.jsx` — shows data-shape expectations, usage of `useAutocomplete`, and how selection navigates to an album.
- `qtify/src/Components/Navbar/Navbar.jsx` — example of wiring `Search` into the header and using a CSS module.
- `qtify/src/helpers/helpers.js` — lightweight helpers used across components (e.g., `truncate`).
- `qtify/src/assets/` — images and SVGs used by components.

**Data shapes & component contracts (practical examples)**

- `Search` expects `searchData` to be an array of objects with at least: `title` (string), `slug` (string), and `songs` (array). Each `song` should have an `artists` array. Example usage in code:

getOptionLabel: (option) => option.title

When rendering the list, the code does:

- `const artists = option.songs.reduce(...);` then `artists.join(", ")` and `truncate(...)` — preserve this shape when providing mock or real data.

**Conventions & patterns to follow**

- One component per folder: `<ComponentName>/<ComponentName>.jsx` (or `.jsx`) plus `<ComponentName>.module.css`.
- Default exports for components (see `Logo.jsx`, `Hero.jsx`).
- Prefer relative imports within `qtify/src` (e.g., `../../helpers/helpers`).
- Keep presentation separated from data loading: components like `Search` accept props (`searchData`) rather than fetching themselves.
- Use MUI styled components where already used (`styled('ul')` pattern in `Search.jsx`).

**Editing and PR guidance for AI code edits**

- Limit changes to `qtify/src` unless updating repo-level config.
- When adding a component, create a folder under `qtify/src/Components/<Name>/` with the `.jsx` and CSS module, and export as default.
- If altering `searchData` shape, update `Search.jsx` accordingly and add unit tests if behavior changes.

**Build, test, and debug steps (Windows `cmd.exe`)**

```
cd qtify
npm install # if dependencies not installed
npm start # run dev server
npm test # run tests
npm run build # production build
```

**What to avoid / watch out for**

- Do not move the CRA app out of `qtify/` or change `react-scripts` unless you know the implications for the build chain.
- Be careful with image imports: some files use `require('../../assets/..')` and others use static imports — keep imports consistent per-file.

If any section here is unclear or you want the instructions tightened for a specific task (tests, routing changes, backend API integration), tell me which area to expand and I'll iterate.
23 changes: 23 additions & 0 deletions qtify/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
70 changes: 70 additions & 0 deletions qtify/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Getting Started with Create React App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
Loading