💻 Simplefolio 💻

📋 Table of Contents

1. ⚙️ Tech Stack
2. 🔋 Features
3. 🤸 Quick Start
4. ✏️ Personalization
5. 🚀 Deploy
6. 📄 License

⚙️ Tech Stack

• Next JS
• Tailwind CSS

🔋 Features

• ✅ Responsive Design: Ensures optimal display and functionality across all devices.
• ✅ Blog

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Git
• Node.js
• npm (Node Package Manager)

Cloning the Repository

git clone https://github.com/pietropeerani/simplefolio.git simplefolio
cd simplefolio

Installation

Install the project dependencies using npm:

npm i

Running the Project

npm run dev

npm run dev -- -H 0.0.0.0 -p 3000 # host development server on local network

Open http://localhost:3000 in your browser to view the project.

✏️ Personalization

Set Up Enviroment Variables

Go to @/next.config.mjs to modify the general info:

"env": {
  "name": "John",
  "lastName": "Brown"
}

Add Works

1. Go to @/src/app/(pages)/work/articles/ folder.
2. Create a new file with the url name of the page (so without spaces) and a folder in the @/public/work directory with the same name.
3. Add metadata:

---

title: Title
subtitle: Subtitle
image: image.jpg         # cover image
imagePosition: "cover"   # you can also define the contain position 
date: 01-01-2024
textColor: "#fff"
bgColor: "#ff00000d"
render: true

---

🚀 Deploy

📄 License

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