Skip to content

Commit 3a5955f

Browse files
Initial commit
0 parents  commit 3a5955f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+20256
-0
lines changed

.github/workflows/gh-pages.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main # Trigger this action when pushing to the 'main' branch
7+
8+
jobs:
9+
build-and-deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v2
15+
16+
- name: Set up Node.js
17+
uses: actions/setup-node@v3
18+
with:
19+
node-version: '16' # Adjust the version if necessary
20+
21+
- name: Install dependencies
22+
run: npm install gh-pages --save-dev
23+
24+
- name: Build project
25+
run: npm run build
26+
27+
- name: Deploy to GitHub Pages
28+
uses: peaceiris/actions-gh-pages@v3
29+
with:
30+
github_token: ${{ secrets.ACCESS_TOKEN }}
31+
publish_dir: ./build # The folder where the built files are located (adjust if necessary)

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Yuji Sato
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Developer Portfolio Template 🚀
2+
3+
![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB) ![Node.js](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white) ![npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![JavaScript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E) ![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white) ![Sass](https://img.shields.io/badge/Sass-CC6699?style=for-the-badge&logo=sass&logoColor=white)
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+
![screenshot](./src/assets//images/screenshot.png)
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

Comments
 (0)