To begin, ensure you have:
- Node.JS: https://nodejs.org/en/
- Git: https://git-scm.com/downloads
- Visual Studio Code (or any IDE): https://code.visualstudio.com/
installed on your computer. Once you are sure you have these installed, proceed to the following steps:
-
Clone the ResumeWebsiteTemplate repository onto your computer and navigate into the main directory
-
Run
npm install
and wait for the installation of the packages to complete, you should see this in the terminal, then you can runnpm start
so you can see a live view of your website in a browser, it should automatically open, but you can find it at localhost:3000. -
Open 'App.js' which is where you will make a large majority of your edits for the page, here you will be able to fill out the following DEFAULT values (keep in mind that you can make more specific names so that it is easier to add more items in the future):
- fullName
- aboutDescription
- schools
- logo, name, description, link (if you want)
- experiences
- logo, name, descrption, link (if you want)
- projects
- logo, name, description, link (if you want)
- skills
- name, description
- contactMe
- logo, url
-
You will also be able to add (import) your profile image, which should be added under 'src/Components/Image/' as a jpeg file, named 'Profile'. This is also where you will be able to add your logos for the section items, such as schoolLogo, workLogo, and projectLogo. (NOTE: For all images make sure to use a 1:1 cropped image, make sure to also compress the jpegs that you have on the page, especially the small ones alongside your experience for faster load times: https://compressjpeg.com/)
-
You will also be able to add (import) social media icons, you can download more social media icons here: https://iconmonstr.com/ - in order to add a social media icon: first, download the icon from iconmonstr (where you can configure the icon) as a PNG, place it under 'src/SocialMediaIcons/' as a simple name, next import the icon near the top of 'App.js' as I have done with GitHub. Finally, near the bottom of 'App.js' add it as I have with GitHub, changing only the url (href) and the src (src={importName}).
-
Once you are completed with making changes, you can run
npm run build
which will then build your website as a single page application, and you can then host it on your preffered site (such as Firebase).
The following is the default 'create react app' ReadMe:
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject
, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject
at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject
will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject
. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify