This is a custom resume using React, NextJS and Netlify CMS
Goals:
- I want to be able to customize my online portfolio without touching my code.
- I want my portfolio to look modern and be responsive.
- I want my portfolio to be customizable at a technical level should I feel like it.
- I want my portfolio to be snappy on modern devices.
- It should look kind of acceptable with js disabled.
- As a stretch goal, I would like to be able to print out my portfolio as a resume
- Todo: Create a 'Template' version of this code to allow others to implement it themselves.
-
Linux:
sudo apt install nodejs npm -
Windows or macOS:
-
Clone the repository
git clone https://github.com/avra-me/avra-me.nextjs.github.io -
Install dependencies, this can take a minute
cd <name of dir> yarn -
Start the local server
yarn start
Your browser should now open and show the app. Otherwise open http://localhost:3000/ in your browser. Editing files will automatically refresh the page.
If you are new to React, you should watch a basic React tutorial first.
If you already know React, then most of the information you need is in the Material-UI documentation.
You can go into src/theme.js and change the primary and secondary color codes at the top of the script to the values you like and some magic will happen.
If you are happy with the state of your website you can run:
yarn build
It will create a folder named out with your compiled project inside. After that copy its contents into your webroot and you are ready to go.
- NextJs - Generating a static site from dynamic content, nextjs supports server-side logic but we don't use it.
- Netlify CMS - A Version controlled content management system, enables content changes without touching the code
- Material-UI - Material Design components
- Framer-Motion - Managed animation handling, could look for a lighter-weight library in future
This project is licensed under the MIT License - see the LICENSE.md file for details.