github-repo-structure

The website is currently live on Netlify, with automatic deploys enabled.

How to run the project locally

1. Clone the repository

   git clone https://github.com/IonianPlayboy/github-repo-structure.git

2. Install the project dependencies (with yarn)

   yarn

3. Start the Vite dev server

   yarn dev

   The website should now be running locally on http://localhost:3000

Type-Check, Compile and Minify for Production

yarn build

You can then preview the production build of the website without deploying :

yarn preview

The production build should now be running locally on http://localhost:5050/

Run Unit Tests with Vitest

yarn test:unit

Run End-to-End Tests with Cypress

yarn build
yarn test:e2e # or `yarn test:e2e:ci` for headless testing

Lint with ESLint

yarn lint

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).