diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 18 insertions, 31 deletions
@@ -1,43 +1,30 @@ -# Astro Starter Kit: Minimal +# Geshem 🌧️ -```sh -npm create astro@latest -- --template minimal -``` - -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! +<img src="public/screenshot.png" height="600" align="right"> -## 🚀 Project Structure +An interactive rain radar clone running on Mapbox GL, see it live at: [https://geshem.space](https://geshem.space) -Inside of your Astro project, you'll see the following folders and files: +The entire service is served off of static assets located in S3 buckets: -```text -/ -├── public/ -├── src/ -│ └── pages/ -│ └── index.astro -└── package.json -``` +- A static main index page, React-based JS bundle and other static assets that are uploaded upon deploy +- Radar images that are collected and indexed every minute by a Python recurring task running on AWS Lambda -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. +For some architectural notes on the deployment process go read https://yuv.al/blog/an-architecture-for-periodically-updating-static-websites/ -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +## Prerequisites -Any static assets, like images, can be placed in the `public/` directory. +- Node.js +- NPM -## 🧞 Commands +## Dev -All commands are run from the root of the project, from a terminal: +Install dependencies and run dev server: -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `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 | +```bash +$ npm install +$ npm run dev +``` -## 👀 Want to learn more? +### Deploy -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +Deployment is handled transparently on Cloudflare Workers. |