New project
Configure, preview every file, download.
my-app · Node API (ts)
16 files
README.md# my-app
my-app — generated with DevHub
## Getting started
```bash
npm install
cp .env.example .env
npm run dev # http://localhost:3000/health
```
## Commands
| Command | What it does |
|---|---|
| `npm run dev` | Start with auto-reload |
| `npm run build` | Compile TypeScript to dist/ |
| `npm start` | Run the server |
| `npm test` | Run the API tests (node:test) |
| `npm run lint` | ESLint |
| `npm run format` | Format with Prettier |
## Project structure
```
src/app.ts routes and middleware (createApp)
src/server.ts starts the server
test/ API tests
```
## Endpoints
| Method | Path | Response |
|---|---|---|
| GET | `/health` | `{ status: "ok" }` |
| GET | `/api/hello?name=Ada` | `{ message: "Hello, Ada" }` |
## Docker
```bash
docker build -t my-app .
docker run --rm -p 3000:3000 my-app
```
## CI
Every push and pull request runs the checks in `.github/workflows/ci.yml`.
## License
MIT
---
Generated with [DevHub](https://github.com/codeitronics/devhub) by CodeITronics.