34 lines
645 B
Markdown
34 lines
645 B
Markdown
# Forge
|
|
|
|
A small local panel for creating project directories with Git initialized.
|
|
|
|
## Requirements
|
|
|
|
- Node.js 20+
|
|
- Git available on `PATH`
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
npm install
|
|
cp .env.example .env.local
|
|
```
|
|
|
|
Set `PROJECTS_ROOT` in `.env.local` to the directory that should contain your projects. If it is omitted, Forge uses `~/projects`.
|
|
|
|
Start the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Open `http://localhost:3000`.
|
|
|
|
## Verification
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
The API only accepts project names and never accepts an arbitrary filesystem path. It rejects names that could escape the configured root or collide with an existing directory.
|