Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 2.74 KB

README.md

File metadata and controls

101 lines (71 loc) · 2.74 KB

FireIsWebsite

GitHub License GitHub last commit Website

My website! Currently hosted through GitHub Pages via an Action.

Project structure:

public/
├── fonts/
└── rss/
src/
├── components/
├── content/
│   └── blog/
├── images/
├── layouts/
├── pages/
│   └── blog/
└── styles/

Installation

...

Prerequisites

Read the Astro quick start guide's prerequisite list.

This project uses pnpm, though you can use npm if you wish. You can check that pnpm/npm is installed in the terminal by running:

# Using pnpm
pnpm -v

# Using npm
npm -v

Setup

First, fork the repo.

Once the prerequisites are installed and you are working off the fork, clone the repository to your local machine.

This can be done from the command line:

git clone [email protected]:FireIsGood/fireis.dev.git ./fireiswebsite

Local Development

You can run the development server through the terminal.

From the command line:

# Default port 1625
pnpm dev

When Astro is done setting up, you should see a success message.

┃ Local    http://localhost:1625/
┃ Network  use --host to expose

There are additional commands you can run from the terminal:

Command Action
pnpm install Installs dependencies
pnpm start Starts local dev server at localhost:1625
pnpm dev Starts local dev server at localhost:1625 and open it
pnpm build Build your production site to ./dist/
pnpm preview Preview your build locally, before deploying
pnpm astro ... Run CLI commands like astro add, astro check
pnpm astro -- --help Get help using the Astro CLI

Contributing

Feel free to add Issues if you see anything wrong.

This is my personal blog, so I will not accept pull requests.

License

MIT