79 lines
2.6 KiB
Markdown
79 lines
2.6 KiB
Markdown
# **Build your portfolio with Once UI's Magic Portfolio**
|
|
|
|
Magic Portfolio was built with [Once UI](https://once-ui.com) for [Next.js](https://nextjs.org). It requires Node.js v18.17+.
|
|
|
|
**1. Clone the repository**
|
|
```
|
|
git clone https://github.com/once-ui-system/magic-portfolio.git
|
|
```
|
|
|
|
**2. Install dependencies**
|
|
```
|
|
npm install
|
|
```
|
|
|
|
**3. Run dev server**
|
|
```
|
|
npm run dev
|
|
```
|
|
|
|
**4. Edit config**
|
|
```
|
|
src/app/resources/config
|
|
```
|
|
|
|
**5. Edit content**
|
|
```
|
|
src/app/resources/content
|
|
```
|
|
|
|
**6. Create blog posts / projects**
|
|
```
|
|
Add a new .mdx file to src/app/blog/posts or src/app/work/projects
|
|
```
|
|
|
|
# **Features**
|
|
|
|
## **Once UI**
|
|
- All tokens, components & features of [Once UI](https://once-ui.com) (v0.3.1)
|
|
|
|
## **SEO**
|
|
- Automatic open-graph and X image generation with next/og
|
|
- Automatic schema and metadata generation based on the content file
|
|
|
|
## **Design**
|
|
- Responsive layout optimized for all screen sizes
|
|
- Timeless design without heavy animations and motion
|
|
- Endless customization options through [data attributes](https://once-ui.com/docs/theming)
|
|
|
|
TIP:
|
|
You try pre-built designs by changing the imports for the config and content in src/app/resources/index.ts
|
|
|
|
## **Content**
|
|
- Render sections conditionally based on the content file
|
|
- Enable or disable pages for blog, work, gallery and about / CV
|
|
- Generate and display social links automatically
|
|
- Set up password protection for URLs
|
|
|
|
# **Authors**
|
|
|
|
Connect with us on X or LinkedIn.
|
|
|
|
Lorant Toth: [X](https://x.com/lorant_one), [LinkedIn](https://www.linkedin.com/in/tothlorant/)
|
|
Zsofia Komaromi: [X](https://x.com/zsofiakomaromi), [LinkedIn](https://www.linkedin.com/in/zsofiakomaromi/)
|
|
|
|
# **Get involved**
|
|
|
|
- Join the [Once UI Discord server](https://discord.com/invite/5EyAQ4eNdS) and share your portfolio with designers and developers!
|
|
- Report a [bug](https://github.com/once-ui-system/magic-portfolio/issues/new?labels=bug&template=bug_report.md).
|
|
|
|
# **License**
|
|
|
|
Distributed under the CC BY-NC 4.0 License.
|
|
- Commercial usage is not allowed.
|
|
- Attribution is required.
|
|
|
|
See `LICENSE.txt` for more information.
|
|
|
|
# **Deploy with Vercel**
|
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fonce-ui-system%2Fmagic-portfolio&project-name=portfolio&repository-name=portfolio&redirect-url=https%3A%2F%2Fgithub.com%2Fonce-ui-system%2Fmagic-portfolio&demo-title=Magic%20Portfolio&demo-description=Showcase%20your%20designers%20or%20developer%20portfolio&demo-url=https%3A%2F%2Fdemo.magic-portfolio.com&demo-image=https%3A%2F%2Fonce-ui.com%2Fimages%2Ftemplates%2Fmagic-portfolio%2Fcover.jpg) |