https://github.com/andrebeolchi/ezfolio
This project is a portfolio for anyone who wants to show their projects and academic formation
https://github.com/andrebeolchi/ezfolio
Last synced: 5 months ago
JSON representation
This project is a portfolio for anyone who wants to show their projects and academic formation
- Host: GitHub
- URL: https://github.com/andrebeolchi/ezfolio
- Owner: andrebeolchi
- Created: 2024-10-23T23:53:14.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-10-24T03:20:24.000Z (over 1 year ago)
- Last Synced: 2024-10-24T19:56:30.015Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 248 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EZFolio
This project is a portfolio for anyone who wants to show their projects and academic formation.
**Table of Contents**
- [EZFolio](#ezfolio)
- [Features](#features)
- [How to run the project?](#how-to-run-the-project)
- [Folder structure](#folder-structure)
- [ADR (Architectural Decision Record)](#adr-architectural-decision-record)
- [Why Next.js?](#why-nextjs)
- [Why Code Standardization?](#why-code-standardization)
- [Why Git Standardization?](#why-git-standardization)
- [Why Imports Standardization?](#why-imports-standardization)
- [Why shadcn/ui?](#why-shadcnui)
## Features
- [x] Home with projects
- [x] Hero
- [x] Academic Formation
- [x] Projects
- [ ] Footer
- [x] Project screen
- [x] Carousel of images
- [x] Description
- [x] Full screen image
- [x] Login screen
- [ ] Admin screen
- [ ] CRUD of hero
- [ ] CRUD of projects
- [ ] CRUD of academic formations
- [ ] CRUD of footer
- Extra features
- [ ] CRUD of categories
## How to run the project?
1. Clone the repository
```bash
git clone git@github.com:andrebeolchi/ezfolio.git
```
2. Install the dependencies
```bash
yarn install
```
3. Run the project
```bash
yarn dev
```
## Folder structure
The default folder structure of a Next.js project includes the following directories:
- `src/app`: Contains the custom `App` component of the application
- I will use the App Routing structure to create routes
- `src/components`: Contains the reusable components of the application
- `src/lib`: Contains utility functions and business logic
## ADR (Architectural Decision Record)
### [Why Next.js?](./docs/ADR001-nextjs.md)
### [Why Code Standardization?](./docs/ADR002-code-standardization.md)
### [Why Git Standardization?](./docs/ADR003-git-standardization.md)
### [Why Imports Standardization?](./docs/ADR004-imports-standardization.md)
### [Why shadcn/ui?](./docs/ADR005-shadcn.md)