Skip to main content
You can run TryDevUtils as a web application on your local machine or deploy it to a hosting platform.

Prerequisites

Before you begin, ensure you have:
  • Node.js (version 16 or higher)
  • npm package manager

Local development

1

Clone the repository

Clone the TryDevUtils repository to your local machine:
git clone https://github.com/yourusername/trydevutils.git
cd trydevutils
2

Install dependencies

Install the required npm packages:
npm install
3

Start the development server

Run the development server on port 8080:
npm run dev
4

Access the application

Open your browser and navigate to:
http://localhost:8080

Production build

To create a production-ready build:
1

Build the application

Generate optimized production assets:
npm run build
This compiles and minifies your application for deployment.
2

Preview the production build

Test the production build locally:
npm run preview
This runs both the build and preview server.

Deployment

The project is configured for automatic deployment:
  • Vercel: Automatically deploys preview builds on pull requests and production builds from the main branch
  • GitHub Actions: Runs build validation and tests on every push and pull request

Available scripts

ScriptDescription
npm run devStart development server on port 8080
npm run buildBuild for production
npm run previewBuild and preview production version
npm run checkRun TypeScript checks and build
npm run lintRun ESLint code linting
npm run testRun Playwright tests

Troubleshooting

If you encounter issues:
  1. Port already in use: The default port is 8080. If it’s occupied, the development server will use an alternative port
  2. Dependencies not installing: Clear your node_modules folder and package-lock.json, then run npm install again
  3. Build errors: Run npm run check to identify TypeScript errors before building

Build docs developers (and LLMs) love