Skip to content

Commit

Permalink
docs(v1.4.0): Add Docker support section and instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
saqibbedar committed Oct 11, 2024
1 parent 3599446 commit 149b6bb
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 47 deletions.
70 changes: 25 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<div align="center">
<span><h1><a href="https://saqibbedar.github.io/Reactfolio/" target="_blank">Reactfolio.</a> v1.3.0</h1></span>
<span><h1><a href="https://saqibbedar.github.io/Reactfolio/" target="_blank">Reactfolio.</a> v1.4.0</h1></span>

<span>Designed for developers looking to showcase their work with style and simplicity.</span>

Expand All @@ -22,36 +22,34 @@

**Reactfolio** is a customizable portfolio template built with React, Vite, and TailwindCSS. This template allows you to easily create your own developer portfolio for free. It is designed to be flexible and easy to modify, with all the data stored in a single [`assets.js`](https://github.com/saqibbedar/Reactfolio/blob/main/src/assets/assets.js) file.

# Quick Demo
# Quick Demo 🎥

Check out the live demo of the portfolio [here](https://saqibbedar.github.io/Reactfolio/).

# Docker Support 🐳

# Prerequisite
Starting from version v1.4.0, Reactfolio supports Docker. If you prefer to containerize your portfolio and deploy it using Docker, please follow the instructions in the `docker-deploy` branch.

Before starting, ensure you have the following installed on your machine:
To access the Docker documentation, switch to the `docker-deploy` branch and follow the instructions provided there.

1. **Git:** Download and install Git from [here](https://git-scm.com/downloads).

> **Note:** You do not need Node.js installed on your machine as the build and deployment process will be handled by GitHub Actions.
Read [Docker Documentation](https://github.com/saqibbedar/Reactfolio/tree/docker-deploy?tab=readme-ov-file) for more details.


# Getting started
# Installation & Setup 🛠️

Follow these steps to create and deploy your portfolio:

## Step 1: Fork and Clone the Repository
## Step 1: Fork and Clone the Repository 📂

To begin, you should fork this repository so you have your own copy of the project.

1. Click the **Fork** button at the top-right corner of this page to create a copy of the repository in your GitHub account.
2. Once the repository is forked, clone it to your local machine by running the following command in your terminal:

```bash
git clone https://github.com/saqibbedar/Reactfolio.git
```
```bash
git clone https://github.com/saqibbedar/Reactfolio.git
```

## Step 2: Update [`assets.js`](https://github.com/saqibbedar/Reactfolio/blob/main/src/assets/assets.js) file Data
## Step 2: Update [`assets.js`](https://github.com/saqibbedar/Reactfolio/blob/main/src/assets/assets.js) file Data 📝

The main data for the portfolio is located in the `assets.js` file. Open it and replace the dummy data with your actual information:

Expand All @@ -72,7 +70,7 @@ const AboutPage = {
// Similarly, update other values as needed...
```
## Step 3: Push Changes to GitHub
## Step 3: Push Changes to GitHub 🚀
Once you’ve updated the `assets.js` file, you can push your changes to your GitHub repository.
Expand All @@ -82,49 +80,31 @@ git commit -m "Customize portfolio"
git push origin main
```
## Step 4: Automatic Deployment via GitHub Actions

The GitHub Actions workflow will automatically handle the following tasks whenever you push to the main branch:
## Your Portfolio is Live! 🎉
* **Update `vite.config.js`**: It will automatically set the correct `base` value for your GitHub Pages deployment.
* **Build the project**: Vite will create a production-ready build.
* **Deploy to GitHub Pages**: Your portfolio will be deployed to GitHub Pages.

You can view the live version of your portfolio at [`https://<your-username>.github.io/<repository-name>/`](https://<your-username>.github.io/<repository-name>/) once the action completes successfully.

# Optional: Local Development (If Needed)

If you want to run the project locally, follow these steps:

1. Install [Node.js](https://nodejs.org/en/download/prebuilt-installer) on your machine.
2. Install the dependencies:

```bash
npm install
```

2. Run the development server:

```bash
npm run dev
```
Congratulations! If you followed all the steps correctly, your Portfolio is now live. You can view your portfolio at [`https://<your-username>.github.io/<repository-name>/`](https://<your-username>.github.io/<repository-name>/).
You can view your site locally at [`http://localhost:5173`](http://localhost:5173)

# Community & Feedback
# Community & Feedback 💬
We'd love to hear from you! Whether you have questions, ideas, or feedback, you can engage with the Reactfolio community in our GitHub Discussions. Share your experience, ask questions, or suggest features.
[Join the discussion](https://github.com/saqibbedar/Reactfolio/discussions)
By participating in the discussions, you’ll help shape the future of Reactfolio. Feel free to start a new conversation or respond to existing ones!
# Contributing
If you are facing any issues or errors while creating your portfolio, feel free to ask in the discussion. We are always available to help you with your queries.
# Contributing 🤝
We welcome contributions from everyone! By contributing to this project, you not only help improve it but also get your contributions recognized on the ORCID platform. I have contributed to this project on [ORCID](https://orcid.org/0009-0006-2554-8074), where it is properly described and cited under software.
Feel free to open issues or submit pull requests. Your contributions will be acknowledged, and you can add them to your ORCID profile to showcase your work and gain recognition in the academic and professional community.
Feel free to contribute to this project by opening issues or submitting pull requests. We welcome contributions from everyone!
Join us in making this project better and get your contributions recognized!
# Sponsor Project ❤️
# Support Project ❤️
This project is completely free under the [`MIT LICENSE`](https://github.com/saqibbedar/Reactfolio?tab=MIT-1-ov-file). If you’ve found this project helpful and would like to support its development, you can consider buying me a coffee. Your support is greatly appreciated!
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "reactfolio",
"private": true,
"version": "1.3.0",
"version": "1.4.0",
"type": "module",
"scripts": {
"dev": "vite",
Expand Down

0 comments on commit 149b6bb

Please sign in to comment.