|
| 1 | +# ScopeCreep.zip Website |
| 2 | + |
| 3 | +Professional cybersecurity research and platform engineering with a kawaii twist. This is the source code for [scopecreep.zip](https://scopecreep.zip). |
| 4 | + |
| 5 | +## About |
| 6 | + |
| 7 | +ScopeCreep.zip is the collaborative platform of Kali Jackson and Kat Morgan, blending technical excellence with creative innovation in cybersecurity and platform engineering. |
| 8 | + |
| 9 | +## Features |
| 10 | + |
| 11 | +- Responsive Jekyll-based static site |
| 12 | +- Podcast platform with centralized service management |
| 13 | +- Social media integration |
| 14 | +- Conference speaking portfolio |
| 15 | +- Technical blog/research section |
| 16 | +- Kawaii-themed design with particle effects |
| 17 | + |
| 18 | +## Documentation |
| 19 | + |
| 20 | +📚 **[View Full Documentation](./docs/)** |
| 21 | + |
| 22 | +- [Architecture Overview](./docs/architecture/overview.md) - System design and technology stack |
| 23 | +- [Getting Started](./docs/deployment/getting-started.md) - Local development setup |
| 24 | +- [Component Library](./docs/components/includes.md) - Reusable components |
| 25 | +- [Theme System](./docs/styling/theme-system.md) - Colors, typography, and styling |
| 26 | +- [Content Updates](./docs/maintenance/content-updates.md) - How to update content |
| 27 | +- [Troubleshooting](./docs/maintenance/troubleshooting.md) - Common issues and solutions |
| 28 | + |
| 29 | +## Quick Start |
| 30 | + |
| 31 | +1. **Install Prerequisites** |
| 32 | + - Ruby (>= 2.7.0) |
| 33 | + - Bundler (>= 2.0) |
| 34 | + - Git |
| 35 | + |
| 36 | +2. **Clone and Setup** |
| 37 | + ```bash |
| 38 | + git clone https://github.com/scopecreepzip/website.git |
| 39 | + cd website |
| 40 | + bundle install |
| 41 | + ``` |
| 42 | + |
| 43 | +3. **Run Locally** |
| 44 | + ```bash |
| 45 | + bundle exec jekyll serve --livereload |
| 46 | + # Open http://localhost:4000 |
| 47 | + ``` |
| 48 | + |
| 49 | +## Project Structure |
| 50 | + |
| 51 | +``` |
| 52 | +website/ |
| 53 | +├── _config.yml # Site configuration |
| 54 | +├── _data/ # YAML data files |
| 55 | +├── _includes/ # Reusable components |
| 56 | +├── _layouts/ # Page templates |
| 57 | +├── _posts/ # Blog posts |
| 58 | +├── _podcasts/ # Podcast episodes |
| 59 | +├── _sass/ # Stylesheets |
| 60 | +├── assets/ # Images, JS, CSS |
| 61 | +└── docs/ # Documentation |
| 62 | +``` |
| 63 | + |
| 64 | +## Deployment |
| 65 | + |
| 66 | +This site is automatically deployed to GitHub Pages when changes are pushed to the main branch. |
| 67 | + |
| 68 | +### Custom Domain Setup |
| 69 | + |
| 70 | +The site uses the custom domain `scopecreep.zip`. The CNAME file is already configured. |
| 71 | + |
| 72 | +### DNS Configuration |
| 73 | + |
| 74 | +For the custom domain to work, configure your DNS with: |
| 75 | +- A records pointing to GitHub Pages IPs: |
| 76 | + - 185.199.108.153 |
| 77 | + - 185.199.109.153 |
| 78 | + - 185.199.110.153 |
| 79 | + - 185.199.111.153 |
| 80 | +- Or a CNAME record pointing to `[your-username].github.io` |
| 81 | + |
| 82 | +## Configuration |
| 83 | + |
| 84 | +- Site configuration: `_config.yml` |
| 85 | +- Social links: `_data/social_links.yml` |
| 86 | +- Podcast services: `_data/podcast_services.yml` |
| 87 | +- Team information: `_data/team.yml` |
| 88 | + |
| 89 | +## Contributing |
| 90 | + |
| 91 | +We welcome contributions! Please see our [documentation](./docs/) for: |
| 92 | +- Code style guidelines |
| 93 | +- Component development |
| 94 | +- Testing procedures |
| 95 | +- Pull request process |
| 96 | + |
| 97 | +## License |
| 98 | + |
| 99 | +© 2025 ScopeCreep.zip - All rights reserved |
0 commit comments