Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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.
- Host: GitHub
- URL: https://github.com/danielkhakbaz/links
- Owner: Danielkhakbaz
- Created: 2023-05-03T07:54:36.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-28T10:14:18.000Z (8 months ago)
- Last Synced: 2024-02-28T11:30:05.767Z (8 months ago)
- Topics: eslint, git, husky, nextjs14, prettier, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://danial-links.vercel.app
- Size: 201 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Danial Khakbaz's Social Links
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-links2. **Install dependencies**:
```tsx
yarn3. **Run the development server**:
```tsx
yarn dev4. **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.