8/15/2024
How to Deploy Your Own DevToolset
Deploy your own DevToolset
Deploy on 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
-
Clone the repository:
git clone https://github.com/iAmCorey/devtoolset cd devtoolset
-
Install dependencies:
npm install pnpm install
-
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
-
Set up your GitHub repository:
- Create a new repository on GitHub
- Create two folders in the repository:
data/json
anddata/md
- In
data/json
, create a file namedresources.json
with an empty array:[]
-
Run the development server:
npm run dev pnpm dev
Visit http://localhost:3000
to see your DevToolset instance running locally.
Deployment
- Push your code to GitHub.
- Log in to Vercel and create a new project from your GitHub repository.
- Configure the environment variables in Vercel:
GITHUB_TOKEN
GITHUB_OWNER
GITHUB_REPO
ACCESS_PASSWORD