Skip to content

Commit 1565d57

Browse files
CodeMeAPixelCodeMeAPixel
committed
feat(add): updated stuff yes
1 parent 8deda26 commit 1565d57

9 files changed

Lines changed: 427 additions & 0 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @CodeMeAPixel

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Code of Conduct
2+
3+
## Our Commitment
4+
5+
FixFX Links is committed to providing a welcoming, inclusive, and harassment-free environment for all contributors and community members, regardless of:
6+
- Age, body size, disability, ethnicity, gender identity and expression
7+
- Level of experience, nationality, personal appearance
8+
- Race, religion, sexual identity and orientation
9+
- Or any other characteristic
10+
11+
## Our Standards
12+
13+
Examples of behavior that creates a positive environment:
14+
15+
- Using welcoming and inclusive language
16+
- Being respectful of differing opinions, viewpoints, and experiences
17+
- Accepting constructive criticism gracefully
18+
- Focusing on what's best for the community
19+
- Showing empathy towards other community members
20+
- Giving credit where it's due
21+
- Helping newer community members learn and grow
22+
23+
Examples of unacceptable behavior:
24+
25+
- Harassment, intimidation, or discrimination of any kind
26+
- Offensive comments related to the characteristics listed above
27+
- Deliberate intimidation, stalking, or following
28+
- Harassing photography or recording without consent
29+
- Unwelcome sexual attention or advances
30+
- Advocating for or encouraging any of the above behaviors
31+
- Any other conduct which could reasonably be considered inappropriate
32+
33+
## Enforcement
34+
35+
Community leaders are responsible for clarifying and enforcing standards of acceptable behavior. They will:
36+
- Remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that violate this Code of Conduct
37+
- Ban temporarily or permanently any contributor for behaviors they deem inappropriate, threatening, offensive, or harmful
38+
- Communicate reasons for moderation decisions when appropriate
39+
40+
## Reporting
41+
42+
Instances of abusive, harassing, or otherwise unacceptable behavior can be reported to the project maintainers at:
43+
44+
**Email:** [hey@codemeapixel.dev](mailto:hey@codemeapixel.dev)
45+
46+
**Subject:** Code of Conduct Violation Report
47+
48+
All reports will be reviewed and investigated. All reports will be treated with confidentiality. Retaliation against anyone making a good-faith report is not tolerated.
49+
50+
## Scope
51+
52+
This Code of Conduct applies within all community spaces, including:
53+
- GitHub issues and pull requests
54+
- Project discussions
55+
- Any communications related to the FixFX Links project
56+
57+
## Acknowledgment
58+
59+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.
60+
61+
---
62+
63+
**Thank you for helping make FixFX Links a positive community!**

‎.github/CONTRIBUTING.md‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
# Contributing to FixFX Links
2+
3+
Thank you for your interest in contributing to FixFX Links! This document provides guidelines and instructions for contributing to the project.
4+
5+
## Code of Conduct
6+
7+
Please be respectful and constructive in all interactions. We're building a welcoming community for everyone.
8+
9+
## Getting Started
10+
11+
### Prerequisites
12+
13+
- Node.js 18+ or Bun
14+
- Git
15+
- Basic knowledge of React, TypeScript, and Tailwind CSS
16+
17+
### Local Development
18+
19+
1. **Clone the repository:**
20+
```bash
21+
git clone https://github.com/CodeMeAPixel/FixFX-LinkInBio.git
22+
cd links.fixfx.wiki
23+
```
24+
25+
2. **Install dependencies:**
26+
```bash
27+
bun install
28+
```
29+
30+
3. **Start the development server:**
31+
```bash
32+
bun run dev
33+
```
34+
The site will be available at `http://localhost:3000`
35+
36+
4. **Create a new branch:**
37+
```bash
38+
git checkout -b feature/your-feature-name
39+
```
40+
41+
## Development Guidelines
42+
43+
### Code Style
44+
45+
- We use **Biome** for formatting and linting
46+
- Run `bun run lint` to check for issues
47+
- Run `bun run format` to auto-format code
48+
49+
### TypeScript
50+
51+
- All code should be properly typed
52+
- No `any` types unless absolutely necessary with a comment explaining why
53+
- Run `bun run build` to verify TypeScript compilation
54+
55+
### Components
56+
57+
- Keep components focused and single-responsibility
58+
- Use Lucide React for icons (don't add new icon libraries)
59+
- Use Tailwind CSS for styling (no inline styles)
60+
- Add proper TypeScript types for all props
61+
62+
### Commits
63+
64+
Follow the Conventional Commits format:
65+
- `feat:` - New features
66+
- `fix:` - Bug fixes
67+
- `docs:` - Documentation changes
68+
- `style:` - Code style changes (formatting, missing semicolons, etc.)
69+
- `refactor:` - Code refactoring without feature changes
70+
- `perf:` - Performance improvements
71+
- `test:` - Adding or updating tests
72+
- `chore:` - Build process, dependencies, etc.
73+
74+
Example:
75+
```
76+
feat(links): add support for custom link categories
77+
fix(ui): correct hover state color on link cards
78+
docs(readme): update installation instructions
79+
```
80+
81+
## Making Changes
82+
83+
### Adding New Features
84+
85+
1. Create a feature branch: `git checkout -b feature/your-feature`
86+
2. Make your changes
87+
3. Test thoroughly: `bun run dev` and `bun run build`
88+
4. Run linting: `bun run lint` and `bun run check`
89+
5. Commit with conventional format
90+
6. Push and create a pull request
91+
92+
### Customizing Link Categories
93+
94+
To add or modify link categories:
95+
1. Edit [src/data/categories.ts](src/data/categories.ts)
96+
2. Follow the existing structure for consistency
97+
3. Use available color options from the color map in [src/components/layouts/LinkHubContent.tsx](src/components/layouts/LinkHubContent.tsx)
98+
99+
### Adding Colors
100+
101+
To add new background colors:
102+
1. Add entries to `bgColorMap` and `glowColorMap` in [src/components/layouts/LinkHubContent.tsx](src/components/layouts/LinkHubContent.tsx)
103+
2. Use Tailwind CSS color classes
104+
3. Ensure the glow effect complements the background
105+
106+
## Testing
107+
108+
- Test your changes locally before submitting
109+
- Verify responsive design works on mobile, tablet, and desktop
110+
- Check that deep linking works: navigate using hashes like `#community` and `#community/github`
111+
- Test pagination when categories have more than 8 links
112+
113+
## Deployment
114+
115+
The project deploys automatically via Cloudflare Workers. To deploy manually:
116+
117+
```bash
118+
# Authenticate with Cloudflare
119+
wrangler login
120+
121+
# Deploy to staging
122+
bun run deploy -- -e staging
123+
124+
# Deploy to production
125+
bun run deploy
126+
```
127+
128+
See [DEPLOYMENT.md](DEPLOYMENT.md) for detailed deployment instructions.
129+
130+
## Reporting Issues
131+
132+
Found a bug or have a feature request? Please:
133+
1. Check if the issue already exists on [GitHub Issues](https://github.com/CodeMeAPixel/FixFX-LinkInBio/issues)
134+
2. Provide clear description and steps to reproduce bugs
135+
3. Include your environment (OS, Node version, browser if applicable)
136+
137+
## Project Structure
138+
139+
```
140+
src/
141+
├── components/
142+
│ ├── Header.tsx # Navigation header
143+
│ ├── icons/ # Custom icons
144+
│ └── layouts/
145+
│ └── LinkHubContent.tsx # Main page component with pagination & deep linking
146+
├── routes/
147+
│ ├── __root.tsx # Root layout with meta tags
148+
│ └── index.tsx # Home page
149+
├── data/
150+
│ ├── categories.ts # Link data
151+
│ ├── profile.ts # User profile
152+
│ └── social-links.ts # Social media links
153+
├── types/
154+
│ └── links.ts # TypeScript types
155+
└── styles.css # Global styles & theme
156+
```
157+
158+
## Questions?
159+
160+
Feel free to reach out:
161+
- Email: [hey@codemeapixel.dev](mailto:hey@codemeapixel.dev)
162+
- GitHub: [CodeMeAPixel/FixFX-LinkInBio](https://github.com/CodeMeAPixel/FixFX-LinkInBio)
163+
164+
## License
165+
166+
By contributing to FixFX Links, you agree that your contributions will be licensed under the same license as the project (see [LICENSE](LICENSE)).
167+
168+
Thank you for contributing!

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: CodeMeAPixel
2+
custom: links.fixfx.wiki

README.md renamed to .github/README.md

File renamed without changes.

‎.github/SECURITY.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Security Policy
2+
3+
## Reporting Security Vulnerabilities
4+
5+
If you discover a security vulnerability in FixFX Links, please **do not** open a public GitHub issue. Instead, please report it responsibly to:
6+
7+
**Email:** [hey@codemeapixel.dev](mailto:hey@codemeapixel.dev)
8+
9+
**Subject:** Security Vulnerability Report - FixFX Links
10+
11+
Please include:
12+
- Description of the vulnerability
13+
- Steps to reproduce (if applicable)
14+
- Potential impact
15+
- Suggested fix (if you have one)
16+
17+
We will acknowledge your report within 48 hours and work with you to address the issue responsibly.
18+
19+
## Security Considerations
20+
21+
### For Users/Deployers
22+
23+
- Keep your Cloudflare Workers account credentials secure
24+
- Use environment variables for sensitive configuration
25+
- Regularly update dependencies: `bun update`
26+
- Monitor Cloudflare security advisories for your Workers deployment
27+
28+
### For Contributors
29+
30+
- Never commit secrets, API keys, or credentials
31+
- Use environment variables (`.env`, `.env.local`) for sensitive data
32+
- These files should be in `.gitignore` and never committed
33+
- Review code for potential XSS or injection vulnerabilities before submitting PRs
34+
35+
### Known Security Best Practices in This Project
36+
37+
1. **Content Security:** All user-generated content is carefully handled
38+
2. **Dependencies:** We use `bun` for reliable dependency management
39+
3. **Deployment:** Hosted on Cloudflare Workers with edge security
40+
4. **TypeScript:** Strict typing helps prevent runtime vulnerabilities
41+
42+
## Third-Party Dependencies
43+
44+
This project uses the following key dependencies:
45+
46+
- **@tanstack/react-start** - React 19 framework
47+
- **tailwindcss** - CSS framework
48+
- **lucide-react** - Icon library
49+
- **@cloudflare/vite-plugin** - Cloudflare Workers integration
50+
51+
These dependencies are regularly updated to patch security vulnerabilities.
52+
53+
## Dependency Scanning
54+
55+
- Use `bun audit` to check for known vulnerabilities:
56+
```bash
57+
bun audit
58+
```
59+
60+
- Run security checks before deploying:
61+
```bash
62+
bun audit --fix
63+
```
64+
65+
## Environment Variables
66+
67+
Never expose the following:
68+
- Cloudflare API tokens (in `wrangler.jsonc`)
69+
- Any third-party service credentials
70+
- Database connection strings (if added in the future)
71+
72+
Use Cloudflare Workers Secrets for sensitive data:
73+
```bash
74+
wrangler secret put SECRET_NAME
75+
```
76+
77+
## Deployment Security
78+
79+
- Always authenticate before deploying: `wrangler login`
80+
- Use separate staging and production environments
81+
- Review changes before deployment
82+
- Enable Cloudflare's DDoS protection
83+
- Ensure HTTPS is enforced
84+
85+
## Security Updates
86+
87+
- Monitor GitHub security advisories for this repository
88+
- Enable Dependabot alerts on your fork
89+
- Review and test dependency updates before committing
90+
91+
## Responsible Disclosure
92+
93+
When responsibly disclosing vulnerabilities:
94+
1. Give us reasonable time to fix the issue before publicly disclosing
95+
2. Avoid accessing other users' data or systems
96+
3. Don't perform any destructive testing
97+
4. Act in good faith
98+
99+
## Contact
100+
101+
For security-related questions or concerns, please contact:
102+
- **Email:** [hey@codemeapixel.dev](mailto:hey@codemeapixel.dev)
103+
- **GitHub:** [CodeMeAPixel/FixFX-LinkInBio](https://github.com/CodeMeAPixel/FixFX-LinkInBio)
104+
105+
## Acknowledgments
106+
107+
We appreciate the security community's help in keeping FixFX Links safe and secure. Security researchers who report vulnerabilities responsibly will be acknowledged in this document (with permission).
108+
109+
---
110+
111+
Last Updated: February 2026

‎.github/workflows/test-build.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Test Build
2+
3+
on:
4+
push:
5+
branches: [master, main, develop]
6+
pull_request:
7+
branches: [master, main, develop]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Setup Bun
17+
uses: oven-sh/setup-bun@v1
18+
with:
19+
bun-version: latest
20+
21+
- name: Install dependencies
22+
run: bun install --frozen-lockfile
23+
24+
- name: Build project
25+
run: bun run build
26+
27+
- name: Check TypeScript compilation
28+
run: bun run build 2>&1 | grep -q "error TS" && exit 1 || exit 0
29+
continue-on-error: true

0 commit comments

Comments
 (0)