Table of Contents
Project description
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
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:
-
Volar LSP as is stated here. (Take Over Mode included)
-
Eslint LSP that will allow you to format the files.
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.
npm run dev
npm run build
npm run test
npm run cy:o
npm run lint:fix
Currently aiming for the v2 release.
Check out the milestone and the the open issues if you would like to contribute.
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!
- Team - Organization repo
- Instagram - @schrodinger_hat
- LinkedIn - Schrödinger Hat
- Twitter - @schrodinger_hat