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

https://github.com/bajrayejoon/minimal-portflio-v2

This is the V2 of my minimal and modern layout framer animated portfolio website
https://github.com/bajrayejoon/minimal-portflio-v2

framer-motion google-analytics minimal modern portfolio-website posthog react-router

Last synced: about 1 month ago
JSON representation

This is the V2 of my minimal and modern layout framer animated portfolio website

Awesome Lists containing this project

README

        

# My React Router App

A modern React application built with React Router and TypeScript.

## Features

- Built with React Router v7
- TypeScript support
- Biome for linting and formatting
- Husky for Git hooks
- Conventional commits with commitlint
- TailwindCSS for styling

## Prerequisites

- Node.js (v16 or higher)
- npm or bun

## Getting Started

1. Clone the repository:
```bash
git clone
cd my-react-router-app
```

2. Install dependencies:
```bash
npm install
# or
bun install
```

3. Start the development server:
```bash
npm run dev
# or
bun run dev
```

## Available Scripts

- `npm run dev` - Start development server
- `npm run build` - Build for production
- `npm run start` - Start production server
- `npm run typecheck` - Run TypeScript type checking
- `npm run lint` - Run Biome linting
- `npm run format` - Format code with Biome
- `npm run validate` - Run all checks (typecheck, lint, format)

## Git Commit Guidelines

This project follows conventional commits specification. Commit messages should be structured as follows:

```
[optional scope]:

[optional body]

[optional footer(s)]
```

Types:
- feat: New feature
- fix: Bug fix
- docs: Documentation changes
- style: Code style changes
- refactor: Code refactoring
- perf: Performance improvements
- test: Adding tests
- chore: Maintenance tasks
- ci: CI/CD changes
- revert: Reverting changes

## License

[MIT](LICENSE)

# Welcome to React Router!

A modern, production-ready template for building full-stack React applications using React Router.

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/remix-run/react-router-templates/tree/main/default)

## Features

- 🚀 Server-side rendering
- ⚡️ Hot Module Replacement (HMR)
- 📦 Asset bundling and optimization
- 🔄 Data loading and mutations
- 🔒 TypeScript by default
- 🎉 TailwindCSS for styling
- 📖 [React Router docs](https://reactrouter.com/)

## Getting Started

### Installation

Install the dependencies:

```bash
npm install
```

### Development

Start the development server with HMR:

```bash
npm run dev
```

Your application will be available at `http://localhost:5173`.

## Building for Production

Create a production build:

```bash
npm run build
```

## Deployment

### Docker Deployment

This template includes three Dockerfiles optimized for different package managers:

- `Dockerfile` - for npm
- `Dockerfile.pnpm` - for pnpm
- `Dockerfile.bun` - for bun

To build and run using Docker:

```bash
# For npm
docker build -t my-app .

# For pnpm
docker build -f Dockerfile.pnpm -t my-app .

# For bun
docker build -f Dockerfile.bun -t my-app .

# Run the container
docker run -p 3000:3000 my-app
```

The containerized application can be deployed to any platform that supports Docker, including:

- AWS ECS
- Google Cloud Run
- Azure Container Apps
- Digital Ocean App Platform
- Fly.io
- Railway

### DIY Deployment

If you're familiar with deploying Node applications, the built-in app server is production-ready.

Make sure to deploy the output of `npm run build`

```
├── package.json
├── package-lock.json (or pnpm-lock.yaml, or bun.lockb)
├── build/
│ ├── client/ # Static assets
│ └── server/ # Server-side code
```

## Styling

This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.

---

Built with ❤️ using React Router.