Quickstart

Prerequisites

Before you begin, make sure you have:

Node.js v18 or later
npm or pnpm
MongoDB Atlas account (or a local MongoDB instance)
API Keys:
- Finnhub API Key (free tier available)
- Google Gemini API Key (optional, for AI features)
- Gmail account with an app password for email

Installation

Clone the repository

git clone https://github.com/marc100s/stocks-signalist.git
cd stocks-signalist

Install dependencies

npm install

Set up environment variables

Copy the example file and fill in your credentials:

cp .env.example .env

See the Environment Variables page for details on each variable.

Run the development server

npm run dev

Navigate to http://localhost:3000 to see the app.

Available Scripts

Script	Description
`npm run dev`	Start development server with Turbopack
`npm run build`	Create production build
`npm run start`	Start production server
`npm run lint`	Run ESLint
`npm run test:db`	Test database connection
`npm run db:clear-users`	Clear all users (development only)

Project Structure

stocks-signalist/
├── app/                      # Next.js App Router
│   ├── (auth)/              # Auth pages (sign-in, sign-up, reset-password)
│   ├── (root)/              # Main app pages (dashboard, watchlist, settings)
│   ├── api/                 # API routes
│   └── globals.css          # Global styles
├── components/              # React components
│   ├── ui/                  # shadcn/ui components
│   └── forms/               # Form components
├── lib/                     # Utility functions
│   ├── actions/             # Server actions
│   ├── better-auth/         # Authentication config
│   ├── inngest/             # Event workflows
│   └── nodemailer/          # Email templates and functions
├── database/                # Database models and connection
├── middleware/              # Next.js middleware
├── public/                  # Static assets
└── scripts/                 # Utility scripts

Getting Started

Authentication

Deployment

Prerequisites

Installation

Available Scripts

Project Structure

Next Steps

Environment Variables

Authentication

​Prerequisites

​Installation

​Available Scripts

​Project Structure

​Next Steps

Environment Variables

Authentication

Prerequisites

Installation

Available Scripts

Project Structure

Next Steps