Lyra
Created for didactic and educational purposes.
[![Deploy to Main Stage 💫](https://github.com/dallay/lyra/actions/workflows/deploy-main-stage.yml/badge.svg)](https://github.com/dallay/lyra/actions/workflows/deploy-main-stage.yml)
[![codecov](https://codecov.io/gh/dallay/lyra/graph/badge.svg?token=i5pxpknTbs)](https://codecov.io/gh/dallay/lyra)
![GitHub stars](https://img.shields.io/github/stars/yacosta738/lyra)
![GitHub issues](https://img.shields.io/github/issues/yacosta738/lyra)
![GitHub forks](https://img.shields.io/github/forks/yacosta738/lyra)
![GitHub PRs](https://img.shields.io/github/issues-pr/yacosta738/lyra)
![Astro Badge](https://img.shields.io/badge/Astro-BC52EE?logo=astro&logoColor=fff&style=flat)
![Typescript Badge](https://img.shields.io/badge/Typescript-007ACC?logo=typescript&logoColor=fff&style=flat)
![Tailwind CSS Badge](https://img.shields.io/badge/Tailwind%20CSS-06B6D4?logo=tailwindcss&logoColor=fff&style=flat)
![Spring Boot Badge](https://img.shields.io/badge/Spring%20Boot-6DB33F?logo=springboot&logoColor=fff&style=flat)
![Kotlin Badge](https://img.shields.io/badge/Kotlin-0095D5?logo=kotlin&logoColor=fff&style=flat)
![Gradle Badge](https://img.shields.io/badge/Gradle-02303A?logo=gradle&logoColor=fff&style=flat)
🛠️ Stack
- Astro - The web framework for content-driven websites (used for the landing page).
- Nuxt - The web framework for the app frontend.
- Typescript - JavaScript with syntax for types.
- Tailwindcss - A utility-first CSS framework for rapidly building custom designs.
- tailwindcss-animated - Extended animation utilities for Tailwind CSS.
- fontsource - Self-host Open Source fonts in neatly bundled NPM packages.
Astro Starter Kit: Basics
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
Developer Guide
Make sure you have setup your local Git Hooks:
git config core.hooksPath .githooks
This repository contains a script to generate SSL certificates and keystores using mkcert
, and configure them for a Spring Boot application. The script will generate PEM files (key.pem
and cert.pem
), a PKCS12 keystore (keystore.p12
), and optionally a Java KeyStore (JKS) (keystore.jks
).
./infra/generate-ssl-certificate.sh
For more information, read the SSL Configuration documentation.
This will make sure your commit messages follow the Conventional Commits Specification.
Create the synbolic link of some important files:
ln -s $(pwd)/apps/frontend/.npmrc $(pwd)/.npmrc
There's nothing special about src/components/
, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the public/
directory.
🧞 Commands
All commands are run from the root of the project, from a terminal:
Command |
Action |
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add , astro check |
npm run astro -- --help |
Get help using the Astro CLI |
👀 Want to learn more?
Feel free to check our documentation or jump into our Discord server.