Simple portfolio site, backed by GitHub API
🌐 lissy93.github.io
A simple site which lists all of your GitHub projects, and creates a dedicated homepage for each of your repos.
Useful as an auto-generated fallback for all of your apps which don't yet have a dedicated website/landing page.
E.g.
[your-username].github.io- List of all your projects[your-username].github.io/[repo]- Homepage for each repo
- Prerequisites: You'll need Node an Git installed.
- Get the code:
git clone git@github.com:Lissy93/as93.git - Install dependencies:
cd as93 && npm i - Start development server:
npm run dev
Fork the repo, and rename to your username (e.g. octocat.github.io).
GitHub Actions will automatically build and publish the site to your https://<your-username>.github.io page.
For manual deployment, follow the Development instructions above, then run yarn build and upload the dist/ to any CDN, static hosting provider or web server.
All user-related settings goes in the config.ts file.
Add your username there, and optionally add any other details to augment repo listings with custom meta.
Other than that, the only other thing you need is a GitHub API key in GITHUB_TOKEN env var (to avoid being limited while fetching repos)
Contributions are welcome! There's a standard Code of Conduct that you should follow.
If you're new to open source, I've put together some guides in Git-In, but feel free to reach out if you need any support.
Not a coder? You can still help, by raising bugs you find, updating docs, or consider sponsoring me on GitHub
The layout was inspired by Sindresorhus's homepage
The app is built with Svelte + SvelteKit, and uses TypeScript and SCSS
Thank you so so much to everyone who sponsors me on GitHub 💖
Lissy93/AS93 is licensed under MIT © Alicia Sykes 2024.
For information, see TLDR Legal > MIT
Expand License
The MIT License (MIT)
Copyright (c) Alicia Sykes <alicia@omg.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included install
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
© Alicia Sykes 2024
Licensed under MIT
Thanks for visiting :)
