Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
nsanthan authored May 16, 2024
0 parents commit 58c53c7
Show file tree
Hide file tree
Showing 76 changed files with 3,255 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/problem-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Problem Report
about: For communicating problems creating your professional portfolio
title: ''
labels: ''
assignees: ''

---

(Please replace this comment with your problem report. Tell us what went wrong.

If it involves console output, then please cut and paste the output into this field---don't take a snapshot and paste the image.

On the other hand, if the problem is with the visual layout of your portfolio, then please do make a snapshot.

Finally, don't forget to include the URL to your repository so we can take a look at it!)
64 changes: 64 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll site to Pages 2

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Ruby
uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
with:
ruby-version: '3.1' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Build with Jekyll
# Outputs to the './_site' directory by default
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
_site/
.DS_Store
.sass-cache/
.jekyll-cache/
.jekyll-metadata
# Gemfile.lock
.idea
.history
Empty file added .nojekyll
Empty file.
3 changes: 3 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
layout: missingpage
---
14 changes: 14 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.2.0"

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", "~> 1.2"
gem "tzinfo-data"
end

gem "webrick", "~> 1.7"
gem 'html-proofer'
gem 'jekyll-gist'
gem 'rouge'
111 changes: 111 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.0)
public_suffix (>= 2.0.2, < 5.0)
colorator (1.1.0)
concurrent-ruby (1.1.10)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.15.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
faraday (2.3.0)
faraday-net_http (~> 2.0)
ruby2_keywords (>= 0.0.4)
faraday-net_http (2.0.3)
ffi (1.15.5)
forwardable-extended (2.6.0)
html-proofer (3.19.4)
addressable (~> 2.3)
mercenary (~> 0.3)
nokogiri (~> 1.13)
parallel (~> 1.10)
rainbow (~> 3.0)
typhoeus (~> 1.3)
yell (~> 2.0)
http_parser.rb (0.8.0)
i18n (1.10.0)
concurrent-ruby (~> 1.0)
jekyll (4.2.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 2.0)
jekyll-gist (1.5.0)
octokit (~> 4.2)
jekyll-sass-converter (2.2.0)
sassc (> 2.0.1, < 3.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
nokogiri (1.13.6-arm64-darwin)
racc (~> 1.4)
nokogiri (1.13.6-x86_64-darwin)
racc (~> 1.4)
nokogiri (1.13.6-x86_64-linux)
racc (~> 1.4)
octokit (4.23.0)
faraday (>= 1, < 3)
sawyer (~> 0.9)
parallel (1.22.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.7)
racc (1.6.0)
rainbow (3.1.1)
rb-fsevent (0.11.1)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.29.0)
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
sawyer (0.9.1)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
typhoeus (1.4.0)
ethon (>= 0.9.0)
unicode-display_width (1.8.0)
webrick (1.7.0)
yell (2.2.2)

PLATFORMS
arm64-darwin-21
x86_64-darwin-18
x86_64-linux

DEPENDENCIES
html-proofer
jekyll (~> 4.2.0)
jekyll-gist
rouge
tzinfo (~> 1.2)
tzinfo-data
webrick (~> 1.7)

BUNDLED WITH
2.4.22
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 TechFolios

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Professional Portfolio

For details on this professional portfolio, please see [Techfolios](https://techfolios.github.io). Additional information can be found in the [documentation](https://techfolios.github.io/docs/overview), including [instructions](https://techfolios.github.io/docs/user-guide/cloud-development) on how to use [GitPod](https://www.gitpod.io/).

### [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/)

### [JSON Cheat Sheet](https://www.w3schools.com/js/js_json.asp)

# Create your own NRTechfolio Repository

## Login to [GitHub](https://github.com)

You will need to [login](https://github.com/login) to GitHub or [create an account](https://github.com/signup). If you create an account, please remember that your username will be associated with all of your activities. You might want to keep it professional.

## Find the [NRTechfolio Template](https://github.com/uhm-descartes/NRTechfolio) Repository

Search for [uhm-descartes/NRTechfolio](https://github.com/uhm-descartes/NRTechfolio) or follow the provided [link](https://github.com/uhm-descartes/NRTechfolio).

## Use the Template

Find the green "Use this template" button in the top left of the screen. Click that button and select "[Create a new repository](https://github.com/new?template_name=NRTechfolio&template_owner=uhm-descartes)" from the dropdown options.

## Create a New Repository

On the "Create a new repository" screen, fill in a name for your new repository in the middle of the page. It is suggested to use "NRTechfolio." Click the green "Create repository" button on the bottom right. Github will then create your new repository using the template and redirect you to the new repository when finished.

## Turn on Pages

* Go to [Settings/Pages](../../settings/pages) from your GitHub Repository, not the Codespace.
* Find the Branch section
* Choose the 'main' branch.
* Note the pages URL. It should be somegthing like `https://awjans.github.io/NRTechfolio/`. This is the URL to your published NRTechfolio and the value will be needed when editing the Config YAML file later.

## Create a New Codespace

On the "<> Code" tab, find the green "<> Code" button. Click that button and select the "Codespaces" tab. Find and click the "Create codespace on main" button, and Github will create a codespace for you to edit your repository without downloading software to your computer. The codespace will be a website named something like "https://tangerine-parakeet-w47p5rppp725xgx.github.dev/", which you can bookmark for fast access later. The README.md file containing these instructions will be previewed so you can continue to follow along.

# Setup Instructions

## Edit Config YAML

* Edit [_config.yml](_config.yml)
* Change 'Molly Maluhia' to your name on line 3
* Change URL on line 5 to match the URL from the Pages configuration of your Repository.
* Change "/template" to "" on line 7

## Edit [Biography JSON](https://techfolios.github.io/docs/quick-start/configure-bio-json)

* Configure [bio.json](_data/bio.json)
* Make the necessary changes so it reflects you.

## Configure [Project Files](https://techfolios.github.io/docs/quick-start/configure-projects)

* In the [projects](projects) folder
* Rename/Edit or Replace the *.md files. Save at least one as a template.

## Configure [Essay Files](https://techfolios.github.io/docs/quick-start/configure-essays)

* In the [essays](essays) folder
* Rename/Edit or Replace the *.md files. Save at least one as a template.

## Configure [Resume](https://techfolios.github.io/docs/quick-start/configure-resume)

## View and Post Portfolio

* Use the URL in `_config.yml` to view your portfolio
* Post your URL to `# nrtechfolios` on Discord
* Follow-up to ensure you portfolio card appears in the [NRT Portfolio Gallery](https://descartes.manoa.hawaii.edu/nrt-portfolios/)
32 changes: 32 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# REQUIRED CHANGES
# Edit next line to provide your own name.
title: Molly Maluhia | Professional Portfolio
# Edit next line, replacing 'techfolios' with your github username
url: "https://dport96.github.io/NRTechfolio/"
# Edit next line so that baseurl is "" if your repo is <username>.github.io
baseurl: "/template"

# OPTIONAL CHANGES
## Specify the theme using any of the css files in css/techfolio-theme
techfolio-theme: default.css
## Specify the formatting for triple backquote code sections.
rouge-theme: github.css

# DON'T CHANGE THE FOLLOWING (unless you know what you're doing)
markdown: kramdown
kramdown:
hard_wrap: false
input: GFM
syntax_highlighter: rouge
strict_front_matter: true
mathjax: true
exclude:
- Gemfile
- Gemfile.lock
- LICENSE
- README.md
include:
- .nojekyll
- _data
plugins:
- jekyll-gist
Loading

0 comments on commit 58c53c7

Please sign in to comment.