Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angeloanan/utils
🔧 | some utilities tools that i require from time to time
https://github.com/angeloanan/utils
port qrcode qrcode-generator utility web
Last synced: 14 days ago
JSON representation
🔧 | some utilities tools that i require from time to time
- Host: GitHub
- URL: https://github.com/angeloanan/utils
- Owner: angeloanan
- License: gpl-3.0
- Created: 2024-03-30T12:46:40.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-09-10T20:21:16.000Z (about 2 months ago)
- Last Synced: 2024-09-10T22:34:08.216Z (about 2 months ago)
- Topics: port, qrcode, qrcode-generator, utility, web
- Language: TypeScript
- Homepage: https://utils.angelo.fyi
- Size: 1.12 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# personal-astro-template
This is my personal template for an [Astro](https://astro.build) project.
It uses the following stack:
* [Bun](https://bun.io)
* [SolidJS](https://solidjs.org)
* [TailwindCSS](https://tailwindcss.com)
It also has some opiniated optimizations for UX/DX that you might miss in other templates:
* Prefetches all links and uses View Transitions by default for seamless navigation
* Autosorts HTML's `` tags for [better performance and SEO](https://rviscomi.github.io/capo.js/)
* Optimizes Docker image output size for production
## Getting Started
To get started, click the "Use this template" button above, or run the following command:
```bash
pnpx degit github:angeloanan/personal-astro-template my-astro-project
```
Then, install the dependencies:
```bash
cd my-astro-project
pnpm install
```
## Pre-production Checklist
Must do:
- [X] Double check for any missing [`getStaticPaths()`](https://docs.astro.build/en/reference/api-reference/#getstaticpaths) on pages with dynamic params.
- [X] Whitelabel package.json with your project information (enable `private: true` if needed)
- [X] Lock dependencies version to major version
- [X] Replace `output` at [astro.config.mjs](./astro.config.mjs) with desired output target.
- `server` is good for mostly server-rendered pages with few static / prerendered content.
- `hybrid` is good for mostly static sites with a few dynamic routes.
- Read more: https://docs.astro.build/en/guides/server-side-rendering/#configure-server-or-hybrid
- [X] If using `hybrid`, disable prerendering on unnecessary API routes
- [X] Replace `site` on [astro.config.mjs](./astro.config.mjs) with your site URL (sitemap)
- [X] Replace SEO configurations at [src/default-seo.ts](./src/default-seo.ts)
- [X] Replace your favicon
- [X] Optimize your robots.txt entry to account for [Verified Bots](https://radar.cloudflare.com/traffic/verified-bots)
- [ ] Setup CI/CD that'll automatically deploy the app on update
- [ ] Docker: Double check for dependencies vs dev-dependencies requirements
Should do:
- [astro.config.mjs](./astro.config.mjs)
- [X] Adjust Astro's [prefetching strategy](https://docs.astro.build/en/guides/prefetch/#prefetch-configuration) to your likings
- [X] Check if your content is compatible with light / dark mode
## Deployment
### Docker
To deploy the app using Docker, you can build and run the image just like any other Docker image:
To build the image, run the following command, replacing your username and app name:
```bash
docker build -t username/image-name .
```
Then, run the following command to deploy the app, replacing your port number:
```bash
docker run -p 4321:4321 username/image-name
```
### Cloudflare
To deploy the app using Cloudflare, you will need to replace the `output` at [astro.config.mjs](./astro.config.mjs) with `cloudflare`.
By default, uncommenting the code will deploy the app using Cloudflare Workers.
You can import the app to your Cloudflare account by importing the Git repository via Cloudflare's web interface.