Swordium

A social news platform, similar to Medium, where registered users can read and share news articles with the community.

Tech Stack

• Framework: Next.js
• UI Library: React
• Styling: Tailwind CSS
• Forms: React Hook Form + Zod validation
• Authentication: Clerk
• UI Components: shadcn UI
• Icons: Lucide React
• Testing: Jest (unit/integration) + Playwright (E2E)

Getting Started

Prerequisites

• Node.js 20.x or higher (see .nvmrc)
• pnpm package manager

Installation

1. Clone the repository:

   git clone https://github.com/rgllm/swordium.git
   cd swordium

2. Install dependencies:

   pnpm install

3. Set up environment variables: Create or modify .env.local with necessary credentials

4. Start the development server:

   pnpm dev

5. Open http://localhost:3000 in your browser to see the application.

Testing

Unit

Run tests with:

pnpm test

E2E Tests

Run E2E tests in headless mode:

pnpm test:e2e

Run E2E tests with UI mode:

pnpm test:e2e:ui

E2E tests are located in the e2e directory at the project root.