This project uses Astro for a fast and performant development experience. To run the development server, follow these steps:
- Install dependencies: Run npm install in the project directory to install all required dependencies.
- Start the development server: Run npm run dev to start the development server. Astro will open your browser and navigate to http://localhost:4321 by default.
This project uses the following technologies:
- Astro: A fast and performant web framework built with TypeScript.
- Tailwind CSS: A utility-first CSS framework for rapid styling.
- TypeScript: For type safety and improved code maintainability.
- Astro Icon: A library for adding beautiful icons to your website.
- Motion: A library for adding animations to your website.
Inside of your Astro project, you'll see the following folders and files:
/
โโโ public/ # Static assets served directly
โ โโโ favicon.svg
โ โโโ ...other image
โโโ src/ # Project source files
โ โโโ assets/ # All asset files
โ โ โโโ icons/ # SVG icons used throughout the site
โ โ โ โโโ home.svg
โ โ โ โโโ ...other svg icons
โ โ โโโ styles/ # Global CSS styles
โ โ โโโ global.css
โ โโโ components/
โ โ โโโ Button.astro
โ โ โโโ ...other global components
โ โ โโโ sections/ # Individual sections
โ โ โโโ Home/ # Home section specific components
โ โ โโโ ...other sections
โ โโโ layouts/ # Main layout template
โ โ โโโ Layout.astro
โ โโโ pages/ # Individual pages
โ โโโ index.astro # Landing page
โโโ package.json # Project dependencies and configuration
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 lint |
Auto format all file using Prettier and fix lint using Eslint |
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 |