Skip to content

Commit 30fb891

Browse files
kantordkantord
committed
Merge branch 'main' into set-up-playwright
2 parents 4e43d58 + 6d45d4c commit 30fb891

37 files changed

Lines changed: 1999 additions & 1020 deletions

‎.env.example‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# ToolHive Cloud UI - Environment Variables
2+
# Copy this file to .env.local and fill in the values
3+
4+
# =============================================================================
5+
# REQUIRED FOR PRODUCTION
6+
# =============================================================================
7+
8+
# OIDC Provider Configuration
9+
# Your OIDC provider's issuer URL (e.g., https://your-oidc-provider.com)
10+
OIDC_ISSUER_URL=
11+
12+
# OAuth2 Client ID from your OIDC provider
13+
OIDC_CLIENT_ID=
14+
15+
# OAuth2 Client Secret from your OIDC provider
16+
OIDC_CLIENT_SECRET=
17+
18+
# OIDC Provider identifier (e.g., "okta", "auth0", "oidc")
19+
# Must use NEXT_PUBLIC_ prefix (required for both server and client)
20+
NEXT_PUBLIC_OIDC_PROVIDER_ID=
21+
22+
# Better Auth Configuration
23+
# Secret key for token encryption (generate with: openssl rand -base64 32)
24+
BETTER_AUTH_SECRET=
25+
26+
# Your application's base URL (e.g., https://your-app.example.com)
27+
BETTER_AUTH_URL=
28+
29+
# Backend API Configuration
30+
# ToolHive Registry Server API URL
31+
API_BASE_URL=
32+
33+
# =============================================================================
34+
# OPTIONAL
35+
# =============================================================================
36+
37+
# Trusted Origins (comma-separated list)
38+
# Additional origins allowed for CORS and auth callbacks
39+
# TRUSTED_ORIGINS=http://localhost:3002,http://localhost:3003
40+
41+
# =============================================================================
42+
# DEVELOPMENT ONLY (automatically set by dev server)
43+
# =============================================================================
44+
45+
# These are set automatically when running 'pnpm dev'
46+
# No need to set them manually for local development
47+
48+
# NODE_ENV=development
49+
# OIDC_ISSUER_URL=http://localhost:3001
50+
# OIDC_CLIENT_ID=web-client
51+
# OIDC_CLIENT_SECRET=web-secret
52+
# NEXT_PUBLIC_OIDC_PROVIDER_ID=oidc
53+
# BETTER_AUTH_URL=http://localhost:3000
54+
# API_BASE_URL=http://localhost:9090

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ yarn-error.log*
3636

3737
# env files (can opt-in for committing if needed)
3838
.env*
39+
!.env.example
3940

4041
# vercel
4142
.vercel

‎CODE_OF_CONDUCT.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <code-of-conduct@stacklok.com>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributing to ToolHive Cloud UI
2+
3+
<!-- omit from toc -->
4+
5+
First off, thank you for taking the time to contribute to ToolHive Cloud UI! :+1: :tada:
6+
7+
ToolHive Cloud UI is released under the Apache 2.0 license. If you would like to contribute something or want to hack on the code, this document should help you get started. You can find development guidelines in the [README.md](./README.md).
8+
9+
## Table of contents
10+
11+
<!-- omit from toc -->
12+
13+
- [Code of conduct](#code-of-conduct)
14+
- [Reporting security vulnerabilities](#reporting-security-vulnerabilities)
15+
- [How to contribute](#how-to-contribute)
16+
- [Using GitHub Issues](#using-github-issues)
17+
- [Not sure how to start contributing?](#not-sure-how-to-start-contributing)
18+
- [Pull request process](#pull-request-process)
19+
- [Commit message guidelines](#commit-message-guidelines)
20+
21+
## Code of conduct
22+
23+
This project adheres to the [Contributor Covenant](./CODE_OF_CONDUCT.md) code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [code-of-conduct@stacklok.com](mailto:code-of-conduct@stacklok.com).
24+
25+
## Reporting security vulnerabilities
26+
27+
If you think you have found a security vulnerability in ToolHive Cloud UI please DO NOT disclose it publicly until we've had a chance to fix it. Please don't report security vulnerabilities using GitHub issues; instead, please follow this [process](./SECURITY.md)
28+
29+
## How to contribute
30+
31+
### Using GitHub Issues
32+
33+
We use GitHub issues to track bugs and enhancements. If you have a general usage question, please ask in [ToolHive's discussion forum](https://discord.gg/stacklok).
34+
35+
If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible. Ideally, that would include:
36+
37+
- A clear description of the issue
38+
- Steps to reproduce
39+
- Expected vs actual behavior
40+
- Environment details (OS, Node version, browser, etc.)
41+
42+
### Not sure how to start contributing?
43+
44+
PRs to resolve existing issues are greatly appreciated, and issues labeled as ["good first issue"](https://github.com/stacklok/toolhive-cloud-ui/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) are a great place to start!
45+
46+
### Pull request process
47+
48+
- All commits must include a Signed-off-by trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin (DCO). Use `git commit -s` to add this automatically.
49+
50+
- Create an issue outlining the fix or feature.
51+
52+
- Fork the ToolHive Cloud UI repository to your own GitHub account and clone it locally:
53+
54+
```bash
55+
git clone https://github.com/YOUR_USERNAME/toolhive-cloud-ui.git
56+
cd toolhive-cloud-ui
57+
pnpm install
58+
```
59+
60+
- Hack on your changes.
61+
62+
- Ensure code quality before committing:
63+
64+
```bash
65+
pnpm lint # Run linter
66+
pnpm format # Format code
67+
pnpm test # Run tests
68+
pnpm type-check # TypeScript validation
69+
```
70+
71+
- Follow the project guidelines:
72+
73+
- Use Server Components by default, Client Components only when necessary
74+
- Always use the generated hey-api client for API calls
75+
- Use `async/await` (never `.then()` promise chains)
76+
- **Never use `any` type** - use proper types or `unknown` with type guards
77+
- Use shadcn/ui components (don't create custom UI components)
78+
- Follow existing patterns in the codebase
79+
80+
See [AGENTS.md](./AGENTS.md) and [CLAUDE.md](./CLAUDE.md) for detailed guidelines.
81+
82+
- Correctly format your commit messages, see [Commit message guidelines](#commit-message-guidelines) below.
83+
84+
- Open a PR with a title that follows the conventional commit format (e.g., `feat: add new feature` or `fix: resolve issue`). The PR title will be validated to ensure it follows the conventional commit specification. Ensure the description reflects the content of the PR.
85+
86+
- Ensure that CI passes, if it fails, fix the failures.
87+
88+
- Every pull request requires a review from the core ToolHive team before merging.
89+
90+
- Once approved, all of your commits will be squashed into a single commit with your PR title.
91+
92+
## Commit message guidelines
93+
94+
We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages:
95+
96+
```text
97+
<type>[optional scope]: <description>
98+
99+
[optional body]
100+
101+
[optional footer(s)]
102+
```
103+
104+
**Types:**
105+
106+
- `feat`: A new feature
107+
- `fix`: A bug fix
108+
- `docs`: Documentation only changes
109+
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
110+
- `refactor`: A code change that neither fixes a bug nor adds a feature
111+
- `perf`: A code change that improves performance
112+
- `test`: Adding missing tests or correcting existing tests
113+
- `chore`: Changes to the build process or auxiliary tools and libraries
114+
115+
**Examples:**
116+
117+
- `feat: add server URL copy functionality`
118+
- `fix(ui): resolve button alignment issue in dark mode`
119+
- `docs: update installation instructions`
120+
- `test: add unit tests for authentication flow`
121+
- `chore: update dependencies`
122+
123+
**Signed-off-by:**
124+
125+
All commits must include a Signed-off-by line:
126+
127+
```bash
128+
git commit -s -m "feat: add new feature"
129+
```
130+
131+
This certifies that you agree to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/).

0 commit comments

Comments
 (0)