Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/danielkhakbaz/links

Access my links via this website.
https://github.com/danielkhakbaz/links

eslint git husky nextjs14 prettier tailwindcss typescript

Last synced: about 19 hours ago
JSON representation

Access my links via this website.

Awesome Lists containing this project

README

        

# Danial Khakbaz's Social Links

![Project Screenshot](https://github.com/Danielkhakbaz/Danielo-Portfolio/blob/master/public/images/projects/links/screen-shot.png)

A simplified link portal for Danial Khakbaz's social media profiles, designed with [Next.js](https://nextjs.org/) for easy navigation and quick access.

## Project Overview

This project serves as a streamlined platform for social media links, created with Next.js for performance and efficiency.

## Table of Contents

- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Development Scripts](#development-scripts)
- [Folder Structure](#folder-structure)

## Features

- **Responsive Design**: Mobile-first, fully responsive layout.
- **Performance Optimization**: Efficient image handling using `sharp`.
- **Fast and Lightweight**: Minimal dependencies to maintain speed and simplicity.
- **SEO Ready**: Basic SEO practices for improved discoverability.

## Technologies Used

- **[Next.js](https://nextjs.org/)** - Framework for server-rendered React applications.
- **[React](https://reactjs.org/)** - Library for UI development.
- **[Tailwind CSS](https://tailwindcss.com/)** - Utility-first CSS framework.
- **[React Icons](https://react-icons.github.io/react-icons/)** - Icon library for consistent iconography.
- **[ESLint](https://eslint.org/)** & **[Prettier](https://prettier.io/)** - Code formatting and linting.
- **[Husky](https://typicode.github.io/husky/)** - Git hooks for pre-commit linting and formatting.

## Installation

To set up this project locally, follow these steps:

1. **Clone the repository**:
```tsx
git clone https://github.com/Danielkhakbaz/links
cd portfolio-links

2. **Install dependencies**:
```tsx
yarn

3. **Run the development server**:
```tsx
yarn dev

4. **Open http://localhost:3000 in your browser to see the project**.

## Development Scripts

Here are some helpful scripts to assist in the development and maintenance of this project:

```dev```: Runs the app in development mode.


```build```: Compiles the app for production.


```start```: Starts the production server.


```lint```: Lints and fixes files using ESLint.


```fix```: Formats files using Prettier.


```check-prettier```: Checks the code format without making changes.