Clone Repository

1. Get NuxtStart repository in your account by following this link.
2. Clone repository to your local machine on desired location:

   # pwd: desired location
   
   git clone https://github.com/<your-account-or-organization>/<configured-repo-name>.git
   cd <configured-repo-name>
   

3. Open the project in your preferred code editor.

Configure Environment

1. Follow the instructions in configuring environment variables guide to setup required services and get the necessary credentials and connection details before configuring .env file.
2. Copy .env.example to .env:

   cp .env.example .env
   

3. Open .env and configure variables
4. Add NuxtStart as remote to get updates:

   git remote add nuxtstart https://github.com/nuxtstart/nuxtstart.git
   

Install Dependencies

pnpm install

Create & Apply Database Migrations

# Generate DB migration for any schema changes
pnpm db:generate

# Apply migrations to database
pnpm db:migrate

Start Development Server

pnpm dev

# Most likely, You can access at http://localhost:3000

Commit & Push Changes

If everything is successful, You may have some changes to commit. You can use following commands to commit and push those changes to your repository.

git add .
git commit -m "Your commit message"
git push origin main