README.md

HackUPC Live

Hi! This is the code of the HackUPC live page.

Project Setup

1. Clone the repo.

   git clone https://github.com/hackupc/hackupc-live.git

2. Open it with VSCode and install this extensions:
   • Volar (and disable Vetur)
   • TypeScript Vue Plugin (Volar).
   • Prettier
   • EsLint
   • StyleLint
   • MarkdownLint
   • Grammarly
3. Install Node.js (preferably with nvm).
4. Install the dependencies:

   npm install

5. Run the project in development mode:

   npm run dev

6. Go to http://localhost:3000/ to preview the app.
7. Install the Vue.js devtools extension (beta) to debug faster.
8. Code. If you're not familiar with Vue 3, read its official documentation, it's very good.
9. Open a Pull Request and ask for reviews to merge to main.
10. Whenever the PR is merged, Netlify will build and deploy automatically. 🧙🏻‍♂️

Edit content

Theme

Theme variables are in src/live/params.scss.

Contents

Most of the content is in src/data or hardcoded into the components.

Schedule

The schedule is in src/data/schedule.ts.

• id can be whatever you want, but all ids must be different.
• dates are D/M/YYYY format at Spain time.

Commands

Install dependencies

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Cypress Component Testing

npm run test:unit # or `npm run test:unit:ci` for headless testing

Run End-to-End Tests with Cypress

npm run build
npm run test:e2e # or `npm run test:e2e:ci` for headless testing

Lint with ESLint

npm run lint

Support

If you need help understanding something of this repo you can ask the previous developers. The ones that made this edition live were:

• Jaume López: Slack @jaume jaumelopez.dev
• Maurici Abad Gutierrez: Slack @mauri mauriciabad.com
• Carlota Catot Bragós: Slack @Carlota carlotacb.dev
• Bernat Torres: Slack @bernatixer bernattorres.com

License

MIT © Hackers@UPC