Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 2.18 KB

deploy-own-devtoolset.md

File metadata and controls

76 lines (58 loc) · 2.18 KB
Raw
title description date
Deploy Your Own DevToolset
How to Deploy Your Own DevToolset
2024-08-15T01:14:40.737Z

Deploy your own DevToolset

Deploy on Vercel

Deploy with Vercel

Features

  • Database-free Architecture: Utilizes GitHub for content storage and management.
  • Dynamic Content: Renders content dynamically using Next.js server-side rendering.
  • Markdown Support: Write your content in Markdown format for easy editing and version control.
  • Admin Interface: Built-in admin panel for content management.
  • Responsive Design: Fully responsive design using Tailwind CSS.
  • SEO Friendly: Optimized for search engines with dynamic metadata.
  • Easy Deployment: Simple deployment process to Vercel.

Prerequisites

  • Node.js (version 14 or later)
  • npm/pnpm/yarn (comes with Node.js)
  • Git
  • GitHub account
  • Vercel account (for deployment)

Installation

  1. Clone the repository:

    git clone https://github.com/iAmCorey/devtoolset
cd devtoolset

  2. Install dependencies:

    npm install
pnpm install

  3. Create a .env.local file in the root directory and add the following:

    GITHUB_TOKEN=your_github_personal_access_token
GITHUB_OWNER=your_github_username
GITHUB_REPO=your_repo_name
ACCESS_PASSWORD=your_secure_access_password

  4. Set up your GitHub repository:

    • Create a new repository on GitHub
    • Create two folders in the repository: data/json and data/md
    • In data/json, create a file named resources.json with an empty array: []

  5. Run the development server:

    npm run dev
pnpm dev

Visit http://localhost:3000 to see your DevToolset instance running locally.

Deployment

  1. Push your code to GitHub.
  2. Log in to Vercel and create a new project from your GitHub repository.
  3. Configure the environment variables in Vercel:
    • GITHUB_TOKEN
    • GITHUB_OWNER
    • GITHUB_REPO
    • ACCESS_PASSWORD