Giter VIP home page Giter VIP logo

kulbk's Introduction

1. Astro Portfolio Template

Open in StackBlitz Open with CodeSandbox

1.1. Table of Contents

1.2. Features ๐Ÿ‘

  • Dark mode toggle
  • Responsive design
  • Easy to customize and extend personal data
  • Fuzzy search for blog posts
  • SEO friendly (robots.txt, sitemap.xml)
  • RSS feed

1.3. What's next? ๐Ÿš€

  • Internationalization (i18n)
  • Projects collection
  • Feel free to open an issue or submit a pull request with your ideas for improving this portfolio template (see Contributing)

1.4. How to use this template ๐Ÿงฐ

Note: this mini-guide assumes you have npm installed on your machine, if you don't, you can download it following the instructions here

  1. Click on the "Use this template" button at the top of the repository.
  2. Create a new repository based on this template.
  3. Clone the repository to your local machine.
  4. Install the dependencies by running npm install
  5. You can now start the development server by running npm run dev (see this section for more commands)
  6. Now you can start customizing the portfolio template by updating the /data/info.ts file with your personal information.

1.4.1. Notes about the contact section ๐Ÿ“ง

If you add/remove something from the contact section in the info.ts file, you will need to update the Contact.tsx file located in the src/components/contact_section directory by simply reflecting the changes you made in the info.ts file. Although, this choice may seem redundant, it allows to separate the data from the view.

1.4.2. Notes about RSS feed ๐Ÿ“ฐ

The RSS feed is generated using the astro-plugin-feed plugin.

To customize it:

  1. Update the site entry in the astro.config.mjs file with your site url.
  2. Modify the rss.xml.js file located in the pages directory to reflect your site's information.

1.4.3. Notes about SEO ๐Ÿค–

Modify the head section of the BaseLayout.astro file located in the src/layouts directory to reflect your site's information.

1.4.4. Notes about styles ๐ŸŽจ

This portfolio template uses Tailwind CSS for styling. You can modify the colors used in the portfolio by updating the tailwind.config.js file located in the root of the project.

1.5. Project Structure ๐Ÿš€

Inside of this portfolio template, you will find the following files and directories:

.
โ”œโ”€โ”€ astro.config.mjs
โ”œโ”€โ”€ LICENSE
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ package-lock.json
โ”œโ”€โ”€ public
โ”‚   โ”œโ”€โ”€ favicon.svg
โ”‚   โ”œโ”€โ”€ pic.jpg
โ”‚   โ””โ”€โ”€ Resume.pdf
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ src
โ”‚   โ”œโ”€โ”€ components
โ”‚   โ”‚   โ”œโ”€โ”€ about_section
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ About.tsx
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Education.tsx
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Experience.tsx
โ”‚   โ”‚   โ”œโ”€โ”€ contact_section
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Contact.tsx
โ”‚   โ”‚   โ”œโ”€โ”€ navbar
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Hamburger.tsx
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Nav.jsx
โ”‚   โ”‚   โ”œโ”€โ”€ post_section
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Blog.astro
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Post.astro
โ”‚   โ”‚   โ”œโ”€โ”€ projects_section
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ ProjectCard.tsx
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ ProjectCarousel.tsx
โ”‚   โ”‚   โ”œโ”€โ”€ search
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Search.tsx
โ”‚   โ”‚   โ”œโ”€โ”€ ToggleDarkMode.jsx
โ”‚   โ”‚   โ””โ”€โ”€ TopButton.jsx
โ”‚   โ”œโ”€โ”€ data
โ”‚   โ”‚   โ””โ”€โ”€ info.ts
โ”‚   โ”œโ”€โ”€ env.d.ts
โ”‚   โ”œโ”€โ”€ layouts
โ”‚   โ”‚   โ”œโ”€โ”€ BaseLayout.astro
โ”‚   โ”‚   โ””โ”€โ”€ PostLayout.astro
โ”‚   โ”œโ”€โ”€ pages
โ”‚   โ”‚   โ”œโ”€โ”€ index.astro
โ”‚   โ”‚   โ”œโ”€โ”€ posts
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ your-post-title.md
โ”‚   โ”‚   โ””โ”€โ”€ posts.astro
โ”‚   โ””โ”€โ”€ styles
โ”‚       โ””โ”€โ”€ global.css
โ”œโ”€โ”€ tailwind.config.mjs
โ””โ”€โ”€ tsconfig.json

1.6. 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

1.7. Tools Used ๐Ÿ› ๏ธ

This portfolio template uses the following tools/libraries/resources:

1.8. Contributing ๐Ÿ—๏ธ

If you would like to contribute to the Astro Portfolio Template, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the main repository.

Thank you very much for your contributions!

See the CONTRIBUTING.md file for more information.

1.9. License ๐Ÿ“

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

kulbk's People

Contributors

bhag41 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.