https://github.com/jamg44/astro-node-express

Astro with Express Example Application
https://github.com/jamg44/astro-node-express

Last synced: about 2 months ago
JSON representation

Astro with Express Example Application

• Host: GitHub
• URL: https://github.com/jamg44/astro-node-express
• Owner: jamg44
• Created: 2023-10-29T11:06:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-01T14:25:31.000Z (about 1 year ago)
• Last Synced: 2024-10-12T07:10:16.120Z (3 months ago)
• Language: Astro
• Homepage:
• Size: 188 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Astro Node Express Example

This repo shows an example of how to integrate Astro with an existing Express website.

**This will help you when you have an existing Express Website and whant to migrate it to Astro. Astro does not need Express**.

Reference: https://docs.astro.build/en/guides/integrations-guide/node/

Follow the commits to see the progress.

## 1 Create express application

```sh

npx express-generator astro-node-express

cd astro-node-express

npm install

npm install nodemon -D

```

## 2 Add Astro

```sh

npm install @astrojs/node

```

Create astro.config.mjs with:

```js

import { defineConfig } from 'astro/config'

import node from '@astrojs/node'

export default defineConfig({

  output: 'server',

  adapter: node({

    mode: 'middleware',

  }),

})

```

```sh

# this generates /dist folder

npx astro build

```

## 3 Add Astro to Express

```js

// app.js

const setupAstroMiddleware = require('./lib/setupAstroMiddleware')

/** Astro pages/middlewares */

setupAstroMiddleware('/', path.join(__dirname, 'dist'), app)

```

Add package.json scripts:

```json

  "scripts": {

    "start": "npm run astro:build && node ./bin/www",

    "dev": "DEBUG=astro-node-express:* nodemon --exec \"npm run astro:build && node ./bin/www\" -e js,mjs,cjs,json,astro,ts,tsx --ignore dist/",

    "astro:build": "astro check && astro build --silent"

  },

```

## Todo

- [X] Add Astro initial pages/styles/layout

- [X] Add Astro island examples

- [ ] Add Astro hot reload on changes