|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 1 | +# AZQUERYSUCKS |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +Course scheduling helper app for Tamkang University course data. |
4 | 4 |
|
5 | | -First, run the development server: |
| 5 | +## Development |
6 | 6 |
|
7 | 7 | ```bash |
8 | | -npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
| 8 | +pnpm install |
12 | 9 | pnpm dev |
13 | | -# or |
14 | | -bun dev |
15 | 10 | ``` |
16 | 11 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 12 | +Open `http://localhost:3000`. |
18 | 13 |
|
19 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 14 | +## Environment |
20 | 15 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 16 | +- `VITE_COURSES_URL` (preferred) |
22 | 17 |
|
23 | | -## Learn More |
| 18 | +If neither is set, the app uses the public GitHub JSON fallback in `src/components/course-scheduler-content.tsx`. |
24 | 19 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 20 | +## Scripts |
26 | 21 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 22 | +- `pnpm dev` - Run TanStack Start in development mode |
| 23 | +- `pnpm build` - Build production assets |
| 24 | +- `pnpm start` - Preview the production build |
| 25 | +- `pnpm test` - Run unit tests |
| 26 | +- `pnpm lint` - Run Biome checks |
| 27 | +- `pnpm test:e2e` - Run Playwright end-to-end tests |
29 | 28 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 29 | +## Static Assets |
31 | 30 |
|
32 | | -## Deploy on Vercel |
| 31 | +- `public/manifest.webmanifest` |
| 32 | +- `public/robots.txt` |
| 33 | +- `public/og.svg` |
| 34 | +- `public/favicon.ico` |
33 | 35 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 36 | +## Deployment (GitHub Pages) |
35 | 37 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 38 | +Deployment is handled directly by GitHub Actions on pushes to `main`, publishing |
| 39 | +`dist` to GitHub Pages at `https://cantpr09ram.github.io/AZQUERYSUCKS/`. |
0 commit comments