ASTRO | FOLIO

Table of Contents

• Description
• Technologies
• Installation
• Usage
• Changing the Default Content
• Deployment and Testing
• Screenshots
• Contributing
• License
• Buy Me a Coffee

Description

Astrofolio is a dynamic and innovative portfolio website that showcases your projects and skills. It features a visually appealing design, with a pretty favicon and a space-themed background. The website includes various interactive elements such as synced onClick music, a dynamic logo, animated job title, glitch effect on menu text, and an innovative navigation menu.

Technologies

Astrofolio is built using the following technologies:

• HTML
• CSS
• JavaScript
• React
• React Router DOM
• React Slick
• Slick Carousel
• TailwindCSS
• TailwindCSS Animation Delay

NPM Package List

Here is a list of the project's dependencies and devDependencies:

Dependencies:

• react
• react-router-dom
• react-slick
• slick-carousel
• tailwindcss-animation-delay

DevDependencies:

• autoprefixer
• postcss
• tailwindcss
• vite

Features

Astrofolio offers the following features:

• Background music with an option to turn it on/off
• Dynamic and innovative logo
• Animated job title
• Glitch effect on menu text and project title
• TV noise effect on navigating
• Full animation throughout the website
• Project preview images on hover
• Project images slider
• Innovative project screenshots grid

Installation

To install and run Astrofolio locally, follow these steps:

1. Clone the repository: git clone https://github.com/AhmedNasser1010/astrofolio
2. Navigate to the project directory: cd astrofolio
3. Install dependencies: npm i

Usage

To start the development server and view Astrofolio in your browser, use the following command:

bash

Copy code

npm run dev

The website will be accessible at http://localhost:5173.

Changing the Default Content

To customize the content displayed on Astrofolio, you can modify the content.json file located at /src/content.json. This JSON file contains the default content for various sections of the website. Update the relevant fields with your own content.

Deployment and Testing

To deploy Astrofolio and run tests, follow these steps:

1. Build the project: npm run build
2. Deploy the generated dist folder to your preferred hosting platform.

For testing, you can use the following command:

bash

Copy code

1. install serve: npm i -g serve
2. go to dist directory: cd dist
3. serve the project: serve

The website will be accessible at http://localhost:3000.

Recommended to deployment on Vercel or Netlify.

Screenshots

Contributing

Contributions to Astrofolio are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the project's GitHub repository.

License

Astrofolio is licensed under the MIT License.

Buy Me a Coffee

If you find Astrofolio helpful, consider buying me a coffee to support future development and maintenance. You can find the donation link.