Skip to main content

​
Prerequisites

Before you begin, make sure you have:

​
Installation

1

Clone the repository

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

Install dependencies

npm install
3

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.
4

Run the development server

npm run dev
Navigate to http://localhost:3000 to see the app.

​
Available Scripts

ScriptDescription
npm run devStart development server with Turbopack
npm run buildCreate production build
npm run startStart production server
npm run lintRun ESLint
npm run test:dbTest database connection
npm run db:clear-usersClear 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

​
Next Steps

Environment Variables

Configure all required and optional variables.

Authentication

Learn about the auth system and how to configure it.