pocketnaut
v1.2.1
Published
PocketNaut is a minimal Astro, PocketBase, and TailwindCSS starter that uses TypeScript and has sane defaults
Downloads
10
Readme
PocketNaut by Nnisarg Gada
🧑🚀 A minimal Astro, PocketBase, and TailwindCSS starter that uses TypeScript and has sane defaults
🚀 Getting Started
Simply run npx pocketnaut
in your terminal and start coding!
📖 Documentation
‼️ Important: Ensure pocketbase
is installed and move it to the backend
folder
🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
/
├── backend/
├── public/
├── src/
│ └── layouts/
│ └── Base.astro
│ └── components/
│ └── pages/
│ └── index.astro
│ └── styles/
│ └── global.css
│ └── utils/
│ └── pocketbase.ts
│ └── icons/
└── package.json
Astro looks for .astro
or .md
files in the src/pages/
directory. Each page is exposed as a route based on its file name.
There's nothing special about src/components/
, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the public/
directory.
🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :------------------------------------------------------------------------------------ |
| npm install
| Installs dependencies |
| npm run dev
| Starts local dev server at localhost:4321
and pocketbase server at localhost:8090
|
| npm run build
| Build your production site to ./dist/
|
| npm run preview
| Preview your build locally, before deploying |
| npm run astro ...
| Run CLI commands like astro add
, astro check
|
| npm run astro -- --help
| Get help using the Astro CLI |