Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jannoelc/profile-website
https://github.com/jannoelc/profile-website
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/jannoelc/profile-website
- Owner: jannoelc
- Created: 2022-08-03T16:51:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-03T17:01:58.000Z (over 2 years ago)
- Last Synced: 2024-03-18T08:31:30.241Z (9 months ago)
- Language: TypeScript
- Size: 1.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Profile website
## Installation
Made with [Next.js](https://nextjs.org) and [Material UI](https://mui.com/material-ui).
Requires Node.js > 14.
Install via `npm install`.
## Configuration
The following files are necessary to be added/changed:
| File | Type | Remarks |
| ------------------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `public/assets/hero-avatar.jpg` | image | This is used on the `HeroSection`. Preferrably a square image. Configure the dimensions on all the usage of `Photo` on `HeroSection`. |
| `public/assets/profile-portrait.jpg` | image | This is used on the `AboutSection`. Preferrably a portrait image. Configure the dimensions on all the usage of `ParallaxImage` on `AboutSection`. |
| `public/assets/profile-avatar.jpg` | image | This is used on the About section. Preferrably a square image that was cropped from `profile-portrait.jpg`. Configure the dimensions on all the usage of `Photo` on `AboutSection`. |
| `src/i18n/translations.en.json` | json | Most, if not all the text on the profile website is placed here. |
| `.env` | dotenv | Either set these variables on your terminal or add them to `.env` - `NEXT_PUBLIC_LINKEDIN_URL`, `NEXT_PUBLIC_GITHUB_URL`, `NEXT_PUBLIC_EMAIL`, `NEXT_PUBLIC_PHONE_NUMBER` |