Skip to content

Comet-Robotics/cometrobotics.org

Repository files navigation

cometrobotics.org

This is Comet Robotics' website. It's written with Astro and deployed on GitHub Pages.

Need to make an edit? The quickest way to get up and running will be to open this repo in GitHub Codespaces using the button below. This will open a web-based code editor which will have all Node.js and all the needed dependencies installed.

Open in GitHub Codespaces

πŸš€ Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
β”œβ”€β”€ public/
β”œβ”€β”€ src/
β”‚   └── pages/
β”‚       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 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 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

πŸ‘€ Want to learn more?

Feel free to check our documentation or jump into our Discord server.

About

🌐 main org website

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors 3

  •  
  •  
  •