# astro-dev-only-routes

> Astro Dev-only Routes 🚀 Make some routes only available in dev mode

Latest version **0.0.2** (published 2023-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install astro-dev-only-routes
pnpm add astro-dev-only-routes
yarn add astro-dev-only-routes
bun add astro-dev-only-routes
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-03-28 |
| First published | 2023-03-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 4 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 (+19 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Moustapha Kebe |
| Maintainers | moustaphadev |
| Keywords | withastro, preview, astro, astro-integration, astro-preview |

## Links

- npm: https://www.npmjs.com/package/astro-dev-only-routes
- Repository: https://github.com/MoustaphaDev/astro-dev-only-routes
- Homepage: https://github.com/MoustaphaDev/astro-dev-only-routes/tree/main/packages/integration/readme.md
- Issues: https://github.com/MoustaphaDev/astro-dev-only-routes/issues
- npm.io page: https://npm.io/package/astro-dev-only-routes

## Dependencies (4)

- [astro](https://npm.io/package/astro.md) ^2.1.7
- [kleur](https://npm.io/package/kleur.md) ^4.1.5
- [slash](https://npm.io/package/slash.md) ^5.0.0
- [globby](https://npm.io/package/globby.md) ^13.1.3

## Recent versions

- 0.0.2 (latest) — 2023-03-28

## README

<h1 align="center">Astro Dev-only Routes 🚀</h1>
<h4 align="center">Make some routes only available in dev mode</h4>

<p align="center">
    <a href="https://github.com/MoustaphaDev/astro-dev-only-routes/blob/master/LICENSE" target="_blank">
        <img src="https://img.shields.io/github/license/MoustaphaDev/astro-dev-only-routes?style=flat-square" alt="astro-dev-only-routes licence" />
    </a>
    <a href="https://github.com/MoustaphaDev/astro-dev-only-routes/issues" target="_blank">
        <img src="https://img.shields.io/github/issues/MoustaphaDev/astro-dev-only-routes?style=flat-square" alt="astro-dev-only-routes issues"/>
    </a>
    <a href="https://github.com/MoustaphaDev/astro-dev-only-routes/pulls" target="_blank">
        <img src="https://img.shields.io/github/issues-pr/MoustaphaDev/astro-dev-only-routes?style=flat-square" alt="astro-dev-only-routes pull-requests"/>
    </a>
    <a href="https://github.com/MoustaphaDev/astro-dev-only-routes/stargazers" target="_blank">
        <img src="https://img.shields.io/github/stars/MoustaphaDev/astro-dev-only-routes?style=flat-square" alt="astro-dev-only-routes stars"/>
    </a>
    <a href="https://npmjs.com/package/astro-dev-only-routes" target="_blank">
        <img src="https://img.shields.io/npm/dt/astro-dev-only-routes.svg" alt="astro-dev-only-routes total downloads" />
    </a>
</p>

<p align="center">
    <a href="https://stackblitz.com/github/MoustaphaDev/astro-dev-only-routes/tree/main/demo" target="_blank">View Demo</a>
    ·
    <a href="https://github.com/MoustaphaDev/astro-dev-only-routes/issues/new/choose" target="_blank">Report Bug</a>
</p>


<!-- TOC start -->
# Table of contents
- [Table of contents](#table-of-contents)
  - [Why `astro-dev-only-routes`?](#why-astro-dev-only-routes)
  - [🚀 Demo](#-demo)
  - [💻 Quickstart](#-quickstart)
  - [🐛 Known Issues](#-known-issues)
  - [🗺️ Roadmap](#️-roadmap)
  - [🛡️ License](#️-license)
  - [🙏 Support](#-support)
<!-- TOC end --><!-- Generated with https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one -->

## Why `astro-dev-only-routes`?
Astro is a great tool for building static websites. However, it doesn't have a way to make some routes only available in dev mode, which could be useful for testing purposes, dashboards, design systems, etc.

`astro-dev-only-routes` is an [Astro](https://astro.build/) integration that allows you to make some routes only available in dev mode.

<strong style="font-size:2rem">Many Thanks to all the `Stargazers`</strong>

[![Stargazers repo roster for astro-dev-only-routes](https://reporoster.com/stars/MoustaphaDev/astro-dev-only-routes)](https://github.com/MoustaphaDev/astro-dev-only-routes/stargazers)

## 🚀 Demo
Try out the minimal demo.

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/MoustaphaDev/astro-dev-only-routes/tree/main/demo)

## 💻 Quickstart

To get started, you can install `astro-dev-only-routes` with the `astro add` CLI tool
```sh
# Using NPM
npx astro add astro-dev-only-routes

# Using YARN
yarn astro add astro-dev-only-routes

# Using PNPM
pnpm astro add astro-dev-only-routes
```

Now that you have installed the integration, you can add dev-only routes by prefixing the route with double underscores (`__`).

Create a new file in the `src/pages` directory and name it `__secret-panel.astro`. This page will only be available in dev mode.
```astro
// src/pages/__secret-panel.astro
---
console.log('This page is only available in dev mode.')
---

<h1>Secret Page</h1>
<p> This page is only available in dev mode. </p>
```

That's it! Now you can run `astro dev` and navigate to `http://localhost:3000/__secret-page` to see the page.
Try running `astro build` and you will see that the page is not included in the build.

## 🐛 Known Issues
-  `index.astro` routes need to be reference with the `index` part instead of just `/`. It's technically possible to fix that but there's a bug in Astro that maskes the fix cause those routes to collide with the root `index.astro` route, even though that's not the case. Gonna open an issue for that.

## 🗺️ Roadmap
This is what's planned for the future. If you have any suggestions, please open an issue.
- [ ] Create a proposal for Astro to add this feature natively.

## 🛡️ License
This project is licensed under the MIT License - see the [`LICENSE`](LICENSE) file for details.

## 🙏 Support

If you liked this project, please give it a ⭐️. That's the best way you can support it!

---
_Source: https://npm.io/package/astro-dev-only-routes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._