An open API service indexing awesome lists of open source software.

https://github.com/fradser/frad-me


https://github.com/fradser/frad-me

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# frad-me

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=FradSer_frad-me&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=FradSer_frad-me)
[![TypeScript](https://img.shields.io/badge/TypeScript-62.7%25-blue)](https://github.com/FradSer/frad-me)
[![Website](https://img.shields.io/badge/website-frad.me-green)](https://frad.me)

A personal website built using modern web technologies to share thoughts, experiences, and showcase projects. Designed for speed, accessibility, and a seamless user experience.

---

## 🚀 Tech Stack

- **Framework**: [Next.js](https://nextjs.org/)
- **Language**: TypeScript (62.7%)
- **Content**: MDX (32.9%)
- **Styling**: CSS with advanced features
- **Deployment**: Vercel

---

## 🌟 Features

- **High Performance**: Optimized with Next.js for fast load times
- **Content Management**: Powered by MDX for flexible and dynamic content
- **Custom Design**: Unique styling and animations for a tailored experience
- **Responsive**: Fully functional on all devices
- **SEO-Friendly**: Built with best practices for search engines
- **Type-Safe Development**: Ensured with TypeScript

---

## 🛠 Quick Start

1. **Clone the Repository**:

```bash
git clone https://github.com/FradSer/frad-me.git
cd frad-me
```

2. **Install Dependencies**:

```bash
pnpm install
```

3. **Start Development Server**:

```bash
pnpm dev
```

4. Open [http://localhost:3000](http://localhost:3000) in your browser.

---

## 📁 Project Structure

```
frad-me/
├── components/ # React components
├── pages/ # Next.js pages
├── public/ # Static assets
├── styles/ # CSS styles
└── content/ # MDX content
```

---

## 🔧 Development Scripts

- `pnpm dev`: Start the development server
- `pnpm build`: Create a production build
- `pnpm start`: Launch the production server
- `pnpm lint`: Run linting for code quality
- `pnpm format`: Format code and content files
- `pnpm release`: Prepare a new release

---

## 🚀 Deployment

The website is automatically deployed to **Vercel** on every push to the `main` branch. The deployment process includes:

1. Building the Next.js application
2. Running quality checks
3. Deploying to production
4. Ensuring quality assurance

---

## ✅ Code Quality

This project adheres to high-quality coding standards:

- **SonarCloud**: Continuous code quality analysis
- **TypeScript**: Strong type-checking
- **ESLint**: Enforced code style consistency
- **Automated Testing & CI/CD**: Robust testing and deployment pipelines

---

## 📜 License

This project is licensed under the [MIT License](LICENSE).

---

## 💬 Contact

For questions or suggestions, please [open an issue](https://github.com/FradSer/frad-me/issues) in the repository.

---

Built with ❤️ by [FradSer](https://x.com/FradSer).