Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/andresfernandez89/profile-nextjs

Web profile project using Next.js, React, and TypeScript, equipped with tools for development, testing, and code formatting to ensure high code quality and maintainability.
https://github.com/andresfernandez89/profile-nextjs

css-modules jest nextjs react react-testing-library vercel

Last synced: 27 days ago
JSON representation

Web profile project using Next.js, React, and TypeScript, equipped with tools for development, testing, and code formatting to ensure high code quality and maintainability.

Awesome Lists containing this project

README

        

# Profile Web in Next.js

## Introduction

Profile Next.js is a project built using Next.js, React, and TypeScript. It includes a robust set of tools for development, testing, and formatting to ensure high code quality and maintainability.

## Demo

https://profile-nextjs-self.vercel.app/

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Stack](#stack)
- [Scripts](#scripts)
- [Configuration](#configuration)
- [Links](#links)

## Stack

The project utilizes the following technologies:

- **Next.js**: The React framework for production.
- **React**: A JavaScript library for building user interfaces.
- **TypeScript**: A typed superset of JavaScript that compiles to plain JavaScript.
- **ESLint**: A pluggable linting utility for JavaScript and JSX.
- **Prettier**: An opinionated code formatter.
- **Husky**: Git hooks made easy.
- **Jest**: A delightful JavaScript Testing Framework with a focus on simplicity.

## Installation

To install the project, follow these steps:

1. Clone the repository:
```bash
git clone
```
2. Navigate to the project directory:
```bash
cd profile-nextjs
```
3. Install the dependencies:
```bash
npm install
```

## Usage

To start the development server, run:

```bash
npm run dev
```

To build the project for production, run:

```bash
npm run build
```

To start the production server, run:

```bash
npm start
```

## Scripts

The following scripts are available in this project:

- **dev:** Starts the development server.
- **build:** Builds the project for production.
- **start:** Starts the production server.
- **format:** Formats the code using Prettier.
- **lint:** Runs ESLint to lint the code.
- **prepare:** Prepares Husky.
- **test:** Runs the tests using Jest.

## Configuration

The project uses the following configuration tools and practices:

- **ESLint** for linting.
- **Prettier** for code formatting.
- **Husky** for managing Git hooks.
- **Lint-staged** to run Prettier on staged files.

## Links

[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/andresfernandez89/)