Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schroedinger-hat/schroedinger-hat-website
Schrödinger Hat Website
https://github.com/schroedinger-hat/schroedinger-hat-website
javascript typescript unocss vite vitest vue vuejs
Last synced: about 2 months ago
JSON representation
Schrödinger Hat Website
- Host: GitHub
- URL: https://github.com/schroedinger-hat/schroedinger-hat-website
- Owner: Schroedinger-Hat
- License: agpl-3.0
- Created: 2022-03-11T11:39:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T09:04:31.000Z (2 months ago)
- Last Synced: 2024-10-24T13:58:39.991Z (2 months ago)
- Topics: javascript, typescript, unocss, vite, vitest, vue, vuejs
- Language: TypeScript
- Homepage: https://www.schroedinger-hat.org/
- Size: 9.49 MB
- Stars: 11
- Watchers: 5
- Forks: 14
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]
Table of Contents
## About The Project
Project description
### Tech stack
- [Vue.js](https://vuejs.org/) - [Repo](https://github.com/vuejs/core)
- [Cypress](https://www.cypress.io/) - [Repo](https://github.com/cypress-io/cypress)
- [SASS](https://sass-lang.com/) - [Repo](https://github.com/sass/sass)
- [Typescript](https://www.typescriptlang.org/) - [Repo](https://github.com/microsoft/TypeScript)
- [UnoCSS](https://unocss.dev/) - [Repo](https://github.com/unocss/unocss)
- [Vite](https://vitejs.dev/) - [Repo](https://github.com/vitejs/vite)
- [Vitest](https://vitest.dev/) - [Repo](https://github.com/vitest-dev/vitest)
## 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](https://github.com/vuejs/language-tools).
For VSCode:
[Install the marketplace extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) 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](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#volar) as is stated here. (Take Over Mode included)
- [Eslint LSP](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#eslint) that will allow you to format the files.
For both editors:
It is important that you activate the [Take Over Mode](https://vuejs.org/guide/typescript/overview.html#volar-takeover-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](https://github.com/schroedinger-Hat/schroedinger-hat-website/milestones) and the the [open issues](https://github.com/schroedinger-Hat/schroedinger-hat-website/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
- Team - [Organization repo](https://github.com/orgs/schroedinger-Hat/people)
- Instagram - [@schrodinger_hat](https://www.instagram.com/schrodinger_hat)
- LinkedIn - [Schrödinger Hat](https://www.linkedin.com/company/schroedinger-hat/mycompany/)
- Twitter - [@schrodinger_hat](https://twitter.com/schrodinger_hat)
[contributors-shield]: https://img.shields.io/github/contributors/schroedinger-Hat/schroedinger-hat-website.svg?style=for-the-badge
[contributors-url]: https://github.com/schroedinger-Hat/schroedinger-hat-website/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/schroedinger-Hat/schroedinger-hat-website.svg?style=for-the-badge
[forks-url]: https://github.com/schroedinger-Hat/schroedinger-hat-website/network/members
[issues-shield]: https://img.shields.io/github/issues/schroedinger-Hat/schroedinger-hat-website.svg?style=for-the-badge
[issues-url]: https://github.com/schroedinger-Hat/schroedinger-hat-website/issues
