Skip to content

README.md

Latest commit

 

History

History
77 lines (59 loc) · 1.99 KB

README.md

File metadata and controls

77 lines (59 loc) · 1.99 KB

ForwardJS

🚀 Getting started

Prerequisites

  • Node.js ≥ 22.0.0
  • npm ≥ 10.0.0

Installation

Clone the repository and install dependencies:

# Clone the repository
git clone https://github.com/OttawaReactJS/forwardjs.com.git

# Navigate to project directory
cd forwardjs.com

# Install dependencies
npm install

Development

Start the development server:

# fetch Meetup data
npm run data

# start dev server
npm run dev

# site will be available at http://localhost:4321

🧞 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
npm run data Uses the scripts/fetchMeetupData.js script
npm run build Build your production site to ./dist/
npm run lint Checks for format and lint errors
npm run lint:fix Fixes format and lint errors
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

🧱 Project Structure

/
├── public/
│   └── favicon.svg
├── src/
│   ├── layouts/
│   │   └── Layout.astro
│   ├── components/
│   │   ├── Hero.astro
│   │   └── ...
│   ├── data/
│   │   ├── pastEvents.json
│   │   └── upcomingEvents.json
│   ├── styles/
│   │   └── global.css
│   └── pages/
│       └── index.astro
├── scripts/
│   └── fetchMeetupData.js
└── package.json