KVARK

TIHLDEs open source frontend for tihlde.org - the organizations main web site.

🚀 Getting started

Kvark requires Node 18.x or higher and pnpm.

# Setup a local repository
git clone https://github.com/tihlde/Kvark.git
cd Kvark

# If this is your first time running the application
pnpm install

# Thats it!

From now on it's enough to run pnpm start to run the application.

⚙ Configuration

The application requires configuration of some environment variables in order to run. These should be put in a .env file in the repository root.

VITE_API_URL=YOUR_API_URL_HERE

❤ Contributing

The Kvark frontend is an open source project built on voluntary work. We are committed to a fully transparent development process and highly appreciate any contributions. Whether you are helping us fixing bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as part of the community.

🤝 Found a bug? Missing a specific feature?

Feel free to file a new issue with a respective title and description on the the tihlde/Kvark repository. If you already found a solution to your problem, we would love to review your pull request! Please format your code with prettier, you can use pnpm format to fix fixable problems. If you open the workspace-file in VSCode, the code will be formatted automatically on save.

📫 Contact

Feel free to send us a message on our official slack channel. Of course you can always reach out to us directly at [email protected].

📘 Licence

The code in this project is licensed under MIT license.