Installation

System Requirements

• Node.js: 18.0.0 or higher
• npm: 8.0.0 or higher (or yarn 1.22.0+)
• Git: Latest stable version
• Database: PostgreSQL 12+ or Convex account
• Memory: Minimum 2GB RAM
• Disk Space: At least 500MB for dependencies

Clone the Repository

git clone https://github.com/your-org/smartfall.git
cd smartfall

Install Dependencies

Using npm:

npm install

Using yarn:

yarn install

Verify Installation

Check that all dependencies are installed correctly:

npm list

You should see a tree of all installed packages without errors.

Generate Prisma Client

If using Prisma as the database adapter:

npm run prisma:generate

Create Environment File

Copy the example environment file:

cp .env.example .env.local

Edit .env.local with your configuration values.

Database Setup

For PostgreSQL

1. Create a new PostgreSQL database:

CREATE DATABASE smartfall;

2. Set your database connection string in .env.local:

DATABASE_URL="postgresql://user:password@localhost:5432/smartfall"

3. Run migrations:

npm run prisma:migrate

For Convex

1. Create a Convex account at https://convex.dev
2. Set your Convex deployment URL in .env.local:

CONVEX_DEPLOYMENT="prod:your-deployment-id"

Verify Setup

Run the development server to verify everything is working:

npm run dev

Visit http://localhost:3000 in your browser. You should see the SmartFall login page.

Troubleshooting

npm ERR! code ERESOLVE

If you encounter peer dependency issues:

npm install --legacy-peer-deps

Prisma Client generation failed

Clear Prisma cache and regenerate:

rm -rf node_modules/.prisma
npm run prisma:generate

Port 3000 already in use

Use a different port:

npm run dev -- -p 3001

Next Steps

• Configure Environment Variables
• Start Running Locally
• Review the Architecture