Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colinespinas/website
https://github.com/colinespinas/website
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/colinespinas/website
- Owner: ColinEspinas
- Created: 2024-09-15T11:17:48.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T22:44:40.000Z (2 months ago)
- Last Synced: 2024-10-26T10:33:25.360Z (2 months ago)
- Language: TypeScript
- Size: 327 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Starter
Battery included Nuxt based starter template for my projects. Created to get a great DX, UX and UI as fast as possible.
## Main Features
- 🛡️ Strongly-typed from database to UI components
- 🔐 Secure authentication system with flexible roles and permissions
- 📈 GDPR & CCPA compliant analytics
- 💸 Payment processing
- 🌍 i18n support
## Built with
- [Nuxt](https://nuxt.com/)
- [Tailwind](https://tailwindcss.com/) + [Radix Vue](https://www.radix-vue.com/)
- [Nuxt icon](https://github.com/nuxt/icon) + [Phosphor icons](https://phosphoricons.com/)
- [Drizzle](https://orm.drizzle.team/)
- [Umami](https://umami.is/)
- [Tolgee](https://tolgee.io/)
## Setup
This project uses [devbox](https://www.jetpack.io/devbox/docs/) to provide a consistent development environment. Make sure you have it [installed](https://www.jetpack.io/devbox/docs/installing_devbox/) before continuing.
Once you have devbox installed, run the following commands to get started:
```bash
# Enter devbox shell
> devbox shell
# Install package managers and dependencies
> pnpm install
# Init postgres and create dev database
> devbox run db:init
> devbox run db:up
> devbox run db:create
# Generate migrations (needed if you deleted .drizzle to reset the migrations)
> pnpm migration:generate
# Run migrations
> pnpm migration:run
# Start the app
> pnpm dev
# (Optional) Start Drizzle studio
> pnpm studio
```
## Development
To get the project running locally, you'll need to start the app and the database:
```bash
# Enter devbox shell
> devbox shell
# Start the database
> devbox run db:up
# Start the app
> pnpm dev
```
To stop the database, run:
```bash
> devbox services stop postgresql
```
### Migrations
Using drizzle as an ORM, we have a lot of tools to manage database migrations:
```bash
# Generate new migrations
pnpm migration:generate
# Drop existing migrations
pnpm migration:drop
# Pull migrations from database
pnpm migration:pull
# Run migrations
pnpm migration:run
```
## Deployment
TODO: Add deployment instructions