Skip to content

AjayLiu/ajayliu.com

Repository files navigation

Netlify Status

Logo

AjayLiu.com

My portfolio website which showcases my major projects
Website »

Table of Contents
  1. About The Project
  2. Getting Started
  3. License
  4. Contact
  5. Acknowledgements

About The Project

This is my first site and also the best maintained one. It was originally made with just raw HTML, CSS, and JavaScript and is now revamped with React, Next.js, and SCSS.

Built With

Getting Started

Here is a guide if you want to clone my website and modify it for yourself, all the way to deployment.

Prerequisites

Installation

  1. Clone the repo
    git clone https://github.com/AjayLiu/ajayliu.com.git
  2. Install packages
    yarn
  3. Create a .env or .env.local file in the root and fill in the following info (if you want)
    RECIPIENT_EMAIL = [email protected] (must match your sendgrid recipient email thing)
    SENDGRID_API_KEY = (i use sengrid to send mail, so just use your api key here if u happen to use sendgrid to send contact emails)
    DISCORD_WEBHOOK_URL = (i also receive a discord notification, place your webhook url here if you want)
    NEXT_PUBLIC_RECAPTCHA_KEY= (get from recaptcha dashboard)
    RECAPTCHA_SECRET_KEY=(get from recaptcha dashboard)
    NODE_VERSION=14.18.0 (if your netlify build crashes during node installation then try upgrading this)
    

Development

To run the development server

yarn dev

Then head over to localhost:3000

To run some serverless backend functions from netlify, use Netlify CLI (install) instead:

netlify dev

Then head over to localhost:8888

Deployment

  1. Publish the site on Netlify using continuous git integration.
  2. Enter the same environment variables in Netlify, same as your .env

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ajay Liu - [email protected]

Project Link: https://github.com/AjayLiu/ajayliu.com

Acknowledgements