|
| 1 | +# Developer Portfolio Template 🚀 |
| 2 | + |
| 3 | +       |
| 4 | + |
| 5 | +## What is this? |
| 6 | + |
| 7 | +This simple portfolio template is designed to showcase your past projects, career history, skill sets, and more. |
| 8 | + |
| 9 | +View the [Demo](https://yujisatojr.github.io/react-portfolio-template/). |
| 10 | + |
| 11 | +**This template is free to use, and no attribution is required.** You can fork or download this repository to customize it for your own use. Please don't forget to leave a ⭐ if you like this portfolio! |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +## Features |
| 16 | + |
| 17 | +✅ Open source (free to use, no attribution required) |
| 18 | +✅ Responsive design & mobile-friendly |
| 19 | +✅ Supports both dark and light modes |
| 20 | +✅ Highly customizable multi-component layout |
| 21 | +✅ Built with modern technologies (React, TypeScript, JavaScript, and SCSS) |
| 22 | + |
| 23 | +## Quick Setup |
| 24 | + |
| 25 | +1. Ensure you have [Node.js](https://nodejs.org/) installed. Check your installation by running: |
| 26 | + |
| 27 | + ```bash |
| 28 | + node -v |
| 29 | + ``` |
| 30 | + |
| 31 | +2. In the project directory, install dependencies: |
| 32 | + |
| 33 | + ```bash |
| 34 | + npm install |
| 35 | + ``` |
| 36 | + |
| 37 | +3. Start the development server: |
| 38 | + |
| 39 | + ```bash |
| 40 | + npm start |
| 41 | + ``` |
| 42 | + |
| 43 | +4. Open [http://localhost:3000](http://localhost:3000) to view the app in the browser. |
| 44 | + |
| 45 | +5. Customize the template by navigating to the `/src/components` directory. Modify texts, pictures, and other information as needed. |
| 46 | + |
| 47 | +The page will reload if you make edits, and you will see any lint errors in the console. |
| 48 | + |
| 49 | +If you are interested in creating a mockup image like the ones from the personal projects section, I recommend [Genmoo](https://gemoo.com/tools/browser-mockup-generator/). This website lets you generate sleek looking browser mockups for free. |
| 50 | + |
| 51 | +## Deployment |
| 52 | + |
| 53 | +You can choose your preferred service (e.g., [Netlify](https://www.netlify.com/), [Render](https://render.com/), [Heroku](https://www.heroku.com/)) for deployment. One of the easiest ways to host this portfolio is using GitHub Pages. Follow the instructions below for a production deploy. |
| 54 | + |
| 55 | +1. **Set Up GitHub Repository** |
| 56 | + |
| 57 | + Create a new repository on GitHub for your portfolio app. |
| 58 | + |
| 59 | +2. **Configure `package.json`** |
| 60 | + |
| 61 | + Edit the following properties in your `package.json` file: |
| 62 | + |
| 63 | + ```json |
| 64 | + { |
| 65 | + "homepage": "https://yourusername.github.io/your-repo-name", |
| 66 | + "scripts": { |
| 67 | + "predeploy": "npm run build", |
| 68 | + "deploy": "gh-pages -d build", |
| 69 | + ... |
| 70 | + } |
| 71 | + } |
| 72 | + ``` |
| 73 | + |
| 74 | + Replace `yourusername` with your GitHub username and `your-repo-name` with the name of your GitHub repository. |
| 75 | + |
| 76 | +3. **Deploy to GitHub Pages** |
| 77 | + |
| 78 | + Run the following command to deploy your app: |
| 79 | + |
| 80 | + ```bash |
| 81 | + npm run deploy |
| 82 | + ``` |
| 83 | + |
| 84 | +4. **Access Your Deployed App** |
| 85 | + |
| 86 | + After successfully deploying, you can access your app at `https://yourusername.github.io/your-repo-name`. |
0 commit comments