Directory

This project hosts links and descriptions of software projects I've created
Live - Ryan's Website Directory

Screenshots:

---

📚 Table of Contents

• What's My Purpose?
• How to Use
• Technologies
• Getting Started (Local Setup)
  • Run Locally
  • Test
  • GitHub Hooks
  • Build
  • Deploy

---

🧠 What's My Purpose?

This is a server side single-page angular frontend created to host links and descriptions to the other software creations I've made. It was inspired by zuul - which is a backend directory for microservice management

---

🚦 How to Use

• Social Banner - At the top is a social banner containing buttons that link to my Github, Linked, and BuyMeACoffee
• Project Slider - This slider swaps between Personal and Profressional projects
• Project - Each project has the following properties
  • (Only Personal) Github Readme Link
  • Name (also a link to website, if available)
  • Description - must click to expand/see

Screenshots:

---

🛠 Technologies

• Framework: Angular 18
• Testing: Karma
• Deployment: GitHub Pages

---

🚀 Getting Started (Local Setup)

• Install node - v18 is needed (v20 also works)
• Clone repo

---

Run Locally

npm install
npm start

---

Test

• Unit
  • ng test || npm run test
• Integration
  • ng e2e || npm run e2e

---

Github Hooks

• Build
  • Trigger: On Push to Main
  • Action(s): Builds application then kicks off gh page action to deploy build output

---

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

---

Deploy

Run npm run prod to build and deploy the project. Make sure to be on master and that it is up to date before running the command. It's really meant to be a CI/CD action

---