- Screenshots
- Description
- Getting Started
- Commands
- Technologies
- Contributing
- Code of Conduct
- Contributors
Welcome π my name is Ana, and i'm a UX Designer learning to program. I decided to undertake this project not only to create my own website and showcase my work, but also to learn how to program it. This is the first version with two sections (Home and About Me), but this page will continue to grow in the future. I chose to make it open source so that the community and anyone who wishes to contribute can feel free to do so. Obviously, those who collaborate will be acknowledged on my website β€οΈ
Before starting, here is the figma with the website design:
Jumpstart your development with astro-starter
by setting up your project environment. Here's how to get everything ready:
To make things super easy, we've set up astro-starter
as a template repository. This means you can generate a new repository with the same directory structure and files. Follow these steps:
- Go to the top right corner of the
astro-starter
GitHub page and click on "Use this template". - When the menu opens, click "Create new repository from template".
- Fill in the repository name and description as you would for any other repo.
After creating your repository from the astro-starter
template, download or clone it to your local machine:
git clone https://github.com/<your-username>/<your-repository-name>.git
cd <your-repository-name>
Replace and with your GitHub username and the name of your newly created repository, respectively.
π Alternative: Clone the Repository
If you prefer to clone the repository directly, you can do so by running the following commands in your terminal:
git clone https://github.com/zyruks/astro-starter.git
cd astro-starter
Ensure you have PNPM installed, then execute the following command within your project directory to install all necessary dependencies:
pnpm install
Now that the dependencies are installed, initiate the development server to bring your project to life:
pnpm run dev
You're all set! Dive into the code and start building something amazing with astro-starter
. Happy coding!
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
pnpm install |
Installs dependencies |
pnpm run dev |
Starts local dev server at localhost:4321 |
pnpm run build |
Build your production site to ./dist/ |
pnpm run preview |
Preview your build locally, before deploying |
pnpm run astro ... |
Run CLI commands like astro add , astro check |
pnpm run astro -- --help |
Get help using the Astro CLI |
pnpm run lint |
Lints the codebase for errors |
pnpm run format |
Formats the codebase using Prettier |
pnpm run astro ... |
Run CLI commands like astro add, astro check |
pnpm run astro -- |
--help Get help using the Astro CLI |
See contributing guide.
See code of conduct.
Made and designed with β€οΈ by Ana Rangel and community.