https://github.com/colinespinas/starter-test

https://github.com/colinespinas/starter-test

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/colinespinas/starter-test
• Owner: ColinEspinas
• Created: 2023-07-25T20:22:12.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-25T20:22:16.000Z (over 1 year ago)
• Last Synced: 2024-10-15T04:12:14.718Z (3 months ago)
• Language: TypeScript
• Homepage: https://starter-test-omega.vercel.app
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Starter

Starter template for my personal projects, works with [Nuxt3](https://nuxt.com/) + [TailwindCSS](https://tailwindcss.com/) on the front, [Nitro](https://nitro.unjs.io/) + [Drizzle](https://orm.drizzle.team/) on the back and compatible with most databases.

## 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

> devbox run app:setup

# Init postgres and create dev database

> devbox run db:init

> devbox run db:up

> devbox run db:create

# Run migrations

> nr migration:run

# Start the app

> nr dev

# (Optional) Start Drizzle studio

> nr 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

> nr dev

```

To stop the database, run:

```bash

> devbox services stop postgresql

```

## Deployment

TODO: Add deployment instructions