search

Schroedinger-Hat / schroedinger-hat-website

Schrödinger Hat Website
https://www.schroedinger-hat.org/
GNU Affero General Public License v3.0
11 stars 14 forks source link
javascript typescript unocss vite vitest vue vuejs

readme

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Issues][issues-shield]][issues-url]


Schrödinger's Hat Website

Logo


Visit repository · Report a bug · Request a feature

Table of Contents
  1. About The Project
  2. Usage
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

Project description

Tech stack

Usage

Project setup

Ensure you have installed

node >= 20.10.0
npm >= 10.2.3

Then, after cloning the project run the command below in the installation folder

npm install

Install recommended VSCode extensions or LSP servers

As we are utilizing Vue3 for this project, you will need to install Vue Volar.

For VSCode:

Install the marketplace extension which will allow you to have the best Vue DX while coding.

Don't forget to open the workspace of the project, which will apply specific rules and extension recommendations:

~/your-folder/schroedinger-hat-website code schroedinger-hat-website.code-workspace

For Neovim:

Proceed with the installation of:

For both editors:

It is important that you activate the Take Over Mode from Volar to get the best DX when using Typescript and Vue. For Neovim you can follow the same link stated above.

Don't hesitate to ask the admins or contributors on how to set it up if you don't manage set it up.

Compiles and hot-reloads for development

npm run dev

Compiles and minifies for production

npm run build

Run your unit tests

npm run test

Run your end-to-end tests

npm run cy:o

Lints and fixes files

npm run lint:fix

Roadmap

Currently aiming for the v2 release.

Check out the milestone and the the open issues if you would like to contribute.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this repository better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

License

Contact