Git Product home page Git Product logo

uxproject's Introduction

About

This project is a SPA application deployed via Netlify.

It has been developed using:

  • Vue 3 (UI framework)
  • Node.js (package manager)
  • Vite (building tool)
  • TailwindCSS (CSS styling)
  • Pinia (state management)
  • Vitest (unit testing)

Data from API

This application retrieves data from the API K-samsök from Swedish National Heritage Board via a service class Ksamsok.js. The data from K-samsök is used to fetch items with images, description etc for the items in the memory game.

Stores

  • backpackStore.js <-- used to store items in the backpack and keep track of the state of the backpack (if backpack is full etc.)
  • gameStore.js <-- used to manage the state of the memory game, set timers and handle game logic.
  • StoryStore.js <-- used to keep track of the current index of story via ArrowButton in MainLayout and feeds that state to StoryPage

Live demo

See how it looks: Mullward Räddar Museet.

Dev enviroment

Recommended IDE Setup

VSCode + ESLint.

Customize Vite configuration

See Vite Configuration Reference.

Project setup

Clone the git repository

git clone https://github.com/ergyl/UXProject.git

Install all the necessary dependencies for the project:

npm install

Developing

While developing the project use this command to compile and hot re-load for development:

npm run dev

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint

Compile and deploy

Run this command to compile and Minify for Production:

npm run build

To deploy for production we used Netlify. You can do this in several different ways, we used dashboard on Netlify.com and deployed the project directly via Github.

Optional
You may also deploy this project from the command line with Netlify CLI. To ensure you have the latest version of Netlify CLI installed, run this command from any directory in your terminal:

npm install netlify-cli -g

In the directory for your project, run the following command to create a new Netlify site:

netlify init

Credits

Developed by ergyl, ciphercraftsman, Ounch1 and with the help of UX-designer students from Yrgo, Gothenburg.

uxproject's People

Contributors

ergyl avatar ciphercraftsman avatar ounch1 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.