Skip to content

Latest commit

 

History

History
107 lines (70 loc) · 3.04 KB

LEARN.md

File metadata and controls

107 lines (70 loc) · 3.04 KB
Raw

Project Name

Portfolio Website with Astro

This repository contains the source code for my personal portfolio website built using Astro. This LEARN.md file will guide you through the project and provide you with all the information you need to understand, set up, and contribute to this website.

Table of Contents

Getting Started

Before you start, make sure you have the necessary prerequisites in place.

Prerequisites

To run this project, you'll need the following software installed on your system:

  • Node.js - Node.js is used for running JavaScript on the server.
  • npm or Yarn - Package managers for installing project dependencies.
  • Astro - The static site generator used for this project.

Installation

  1. Clone this repository to your local machine:

    git clone https://github.com/DevRohit06/Portfolio-website.git

  2. Change into the project directory:

    cd Portfolio-website

  3. Install project dependencies:

    If you're using npm:

    npm install

    If you're using Yarn:

    yarn

Usage

To start the development server and view your portfolio website locally, run the following command:

npm run dev

Your site will be available at http://localhost:3000.

Project Structure

Explain the structure of your project, including key directories and files. Here's an example:

.
├── src/           # Source code for the project
│   ├── components/ # Reusable components
│   ├── layouts/    # Page layouts
│   ├── pages/      # Individual pages
├── public/         # Public assets
├── astro.config.mjs # Astro configuration
├── package.json     # Project dependencies and scripts
└── README.md       # Project documentation

Deployment

Describe how the project is deployed. If you're using a specific hosting service, provide deployment instructions. For example, if you're deploying to Netlify or Vercel, provide the necessary configuration files.

Contributing

We welcome contributions to this project. To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Test your changes thoroughly.
  5. Create a pull request to the main branch of this repository.

Please read our Contributing Guidelines for more details.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Thank you for checking out my portfolio website project. If you have any questions or need assistance, feel free to open an issue.

Happy coding!