https://github.com/amssdias/wizard-quizz

https://github.com/amssdias/wizard-quizz

bem-css css html javascript sass vuejs

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/amssdias/wizard-quizz
• Owner: amssdias
• Created: 2024-09-12T21:14:02.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-09-17T21:13:39.000Z (9 months ago)
• Last Synced: 2025-02-10T23:51:17.890Z (4 months ago)
• Topics: bem-css, css, html, javascript, sass, vuejs
• Language: SCSS
• Homepage: https://amssdias.github.io/wizard-quizz/
• Size: 253 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    


        

    


        Wizard School

    






A wizard quizz to identify which house a student belongs.




[![HTML Badge](https://img.shields.io/badge/-HTML5-E34F26?style=for-the-badge&labelColor=black&logo=html5&logoColor=white)](#)

[![CSS Badge](https://img.shields.io/badge/-css3-1572B6?style=for-the-badge&labelColor=black&logo=css3&logoColor=white)](#)

[![Sass Badge](https://img.shields.io/badge/-Sass-CC6699?style=for-the-badge&labelColor=black&logo=sass&logoColor=white)](#) 

[![Javascript Badge](https://img.shields.io/badge/-Javascript-F0DB4F?style=for-the-badge&labelColor=black&logo=javascript&logoColor=F0DB4F)](#)





![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)

![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white)





  ![GitHub Pages](https://img.shields.io/github/deployments/amssdias/wizard-quizz/github-pages?label=GitHub%20Pages)



## :globe_with_meridians: Live Demo

You can view the live version of the project on GitHub Pages:  

[Wizard Quizz](https://username.github.io/wizard-quizz/)

## :runner: Run

To run the project locally for development, follow these steps:

### 1. Clone the Repository

First, clone the repository to your local machine:

```bash

git clone https://github.com/amssdias/wizard-quizz.git

cd wizard-quizz

```

### 2. Install Dependencies

Make sure you have Node.js and npm installed. Then, install the necessary dependencies by running:

```bash

npm install

```

### 3. Run the Development Server and Sass Watcher

We use npm-run-all to run both the Sass watcher and the development server simultaneously. You can start both processes with the following command:

```bash

npm run dev-all

```

This command will:

- Watch for changes in your Sass files and compile them to CSS.

- Start the Vite development server.

## :rocket: Build

To build and prepare this project for production, we use **Vite** as the build tool. Vite optimizes the project for fast and efficient production deployment.

### Prerequisites

Ensure you have the following installed:

- **Node.js**: (version >= 14.x)

- **npm**: (version >= 6.x)

If you haven't already installed the project dependencies, run:

```bash

npm install

```

### Build for Production

Once the project dependencies are installed, use the following command to build the project:

```bash

npm run build

```

This command will:

- Create a production-ready version of the project.

- Optimize the files by minifying and bundling them.

- Output all files into a folder called deploy-project.

### Deployment

After building the project, you can deploy the contents of the deploy-project folder to your preferred hosting provider.