Skip to content

DevDex's source code

License

Notifications You must be signed in to change notification settings

ferothefox/DevDex

Repository files navigation

Logo

DevDex

A social media for developers.
Learn more »

Discord · Twitter · Issue Tracker

Getting Started

Prerequisites

To run DevDex on your local machine, you need these packages.

  • Node.js (Version: >18)
    • Earlier versions may work, but we recommend using the latest LTS if possible. Use nvm to manage your Node versions.
  • pnpm (recommended)

Development

Setup

  1. Clone the GitHub repo into a public repository

    git clone https://github.com/devdexapp/devdex.git
  2. Create your database

    • We recommend PlanetScale for an easy serverless database platform. Create your database and get its connection URL.
  3. Setup .env

    • Per NextAuth docs, you must set a NEXTAUTH_URL and a NEXTAUTH_SECRET.
    • For Prisma, you must set a DATABASE_URL to a MySQL-compatible database connection URL.
  4. Install packages via pnpm

    pnpm i

    This step will also run Prisma, generating your schema, a client, and push new tables to your database. If this step fails, double check you have set your .env correctly.

  5. Quickstart

    pnpm dev

Deployment

The easiest way to deploy DevDex is using Vercel. You will need a Pro plan due to limits of serverless functions created per deployment.

Deploy with Vercel

Roadmap

We do not currently have a public roadmap available.

Contributing

We do not currently have documentation for contributors.