Portfolio ·

Personal portfolio for Erik Roberts

Installing / Getting started

This project is designed to have as few dependencies as possible. The dependencies it does have are, for the most part, build dependencies.

This project is also ready to be deployed to Azure Static Web Apps with CD.

Developing

Built With

Vite is used for bundle the application. The only runtime dependencies are:

• FontAwesome is used as a source for icons.
• Google reCAPTCHA is used to protect against contact form spam.

As few dependencies as possible are used, and new dependencies should be installed sparingly.

Prerequisites

You should have Node.JS and NPM installed on your computer. Node.js v16 is recommended, but v14 and v18 are also supported. If you have nvm installed, you can switch to the correct Node.js version by running:

nvm use

If you intend to develop and run Azure Functions locally, you also need to install the Azure SWA CLI:

npm install -g @azure/static-web-apps-cli azure-functions-core-tools@3

Setting up Dev

Here are the steps to set up a local development environment.

First clone the repository locally.

git clone https://github.com/robere2/Portfolio.git
cd Portfolio/

Install the dependencies for the client.

cd client
npm install
cd ..

Optionally, if you want to run the Azure Functions locally (as opposed to just the frontend), also install the backend dependencies.

cd api
npm install
cd ..

If you do intend on running the Azure Functions, you also need to create a local.settings.json file.

cp api/sample.local.settings.json api/local.settions.json

And then edit local.settings.json to contain the proper configuration values. These values should be kept secret and not committed to version control.

Running with Functions

To run with functions enabled, simply run:

swa start

Open the application at http://localhost:4280/

Running without Functions

To run without functions enabled, simply run:

cd client
npm run dev

Open the application at http://localhost:3000/

Building

Client

The client can be built via:

npm run build

This will output the built project to /client/dist. You can then start up a simple HTTP server to serve your built application via:

npm run preview

API

The Azure Functions do not have any build steps.

Deploying / Publishing

This project has full continuous deployment support for Azure Functions. Take a look at the GitHub Workflow file to see how it works.

Configuration

No configuration is required for the client.

For the Azure Functions, you must set up local.settings.json to develop locally, as mentioned in the "Setting up Dev" section. Once deployed to Azure, instead of using a local.settings.json file, you will configure your application settings in the Azure Portal.

If you intend to deploy this application on a domain other than https://ecr.dev/, you will need to create your own FontAwesome kit with the custom icons:

• fa-azure
• fa-cpp
• fa-electron
• fa-graphql
• fa-mongodb
• fa-nestjs
• fa-postgres

More information available on FontAwesome's website.

You will also need to set up a custom reCAPTCHA profile for your domain. More information available on Google's website.

Tests

No test suite is currently available.

Refer to issue #24.

Style guide

This project follows the code guidelines found at https://github.com/elsewhencode/project-guidelines.

Pull requests must be linted before being merged. You can lint locally via npm run lint in both api/ and client/. npm run fix will attempt to fix any linter issues.

If development environment setup instructions were followed correctly, then a pre-commit hook should have been installed to automatically lint your staged files before committing. If your changes have any linting issues, then the commit will abort. Even if this is not set up, the GitHub Action will notice the issues for you.

Api Reference

/api/SubmitContact

Submit a "Contact Me" form.

• POST
• Requires body parameters: name, email, subject, body, token.
• Content-Type application/json.

Licensing

This project is licensed under the MIT license.