Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.63 KB

README.md

File metadata and controls

59 lines (38 loc) · 1.63 KB

KontRes

This is a simple page which is used to book TIHLDE's office!

Installation

git clone https://github.com/tihlde/kontresv2.git
cd kontresv2

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

# Thats it!

From now on, it's enough to run pnpm run dev to start 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.

NEXT_PUBLIC_API_URL=YOUR_API_URL_HERE

🔧 Technologies

  • NextJS
  • Typescript
  • Tailwind
  • Shadcn

❤ Contributing

KontRes 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/kontresv2 repository. If you already found a solution to your problem, we would love to review your pull request! Please format your code with prettier. 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 index@tihlde.org.

📘 Licence

The code in this project is licensed under MIT license.