BMDIB Website

Website for BMDIB, built with Astro, TypeScript, and Bootstrap.

Tech Stack

• Framework: Astro
• Language: TypeScript
• Styling: Bootstrap + custom CSS
• Content: Markdown
• Source Control: GitHub

Prerequisites

• Node.js 24
• npm
• nvm for managing the Node.js version

Getting Started

1. Clone the repository

git clone <repository-url>
cd website

2. Use the project's Node.js version

This project uses Node.js 24. If you have nvm installed:

nvm use

If Node.js 24 is not installed yet:

nvm install
nvm use

3. Install dependencies

npm install

4. Start the development server

npm run dev

The site will be available at:

http://localhost:4321

Available Commands

Command	Description
npm run dev	Start the local development server
npm run build	Build the production site
npm run preview	Preview the production build locally
npm run astro -- --help	Display available Astro CLI commands

Project Structure

/
├── public/                 # Static assets
├── src/
│   ├── components/         # Reusable Astro components
│   │   ├── Footer.astro
│   │   └── Header.astro
│   ├── layouts/            # Shared page layouts
│   │   └── BaseLayout.astro
│   ├── pages/              # Page routes
│   │   └── index.astro
│   └── styles/             # Global and custom styles
│       └── global.css
├── .gitignore
├── .nvmrc                  # Node.js version used by the project
├── astro.config.mjs        # Astro configuration
├── package.json            # Project metadata and dependencies
├── package-lock.json       # Locked dependency versions
├── tsconfig.json           # TypeScript configuration
└── README.md            	# Project documentation

Development

Create a feature branch before making changes:

git switch main
git pull origin main
git switch -c feature/<issue-number>-<description>

Make and test your changes locally before opening a pull request.

The production build can be verified locally with:

npm run build
npm run preview

Continuous Integration

This project uses GitHub Actions for continuous integration (CI).

For pull requests targeting main, the CI workflow:

1. Checks out the repository
2. Sets up the Node.js version specified in .nvmrc
3. Installs dependencies with npm ci
4. Builds the production site with npm run build

A pull request must pass CI before it is considered ready to merge.

The workflow configuration is located at .github/workflows/ci.yml.

License

See LICENSE.txt for license information.