docs: add

docs/README.md

@@ -0,0 +1,9 @@
+# ReactJS Boilerplate Documentation
+
+---
+
+## Table of Contents
+
+- [Introduction](introduction.md)
+- [Installing and Running](installing-and-running.md)
+- [Testing](testing.md)

docs/installing-and-running.md

@@ -0,0 +1,71 @@
+# Installation
+
+---
+
+## Table of Contents <!-- omit in toc -->
+
+- [Installation](#installation)
+  - [Development](#development)
+  - [Production build](#production-build)
+
+---
+
+## Development
+
+1. Clone repository
+
+   ```bash
+   git clone --depth 1 https://github.com/brocoders/react-boilerplate.git my-app
+   ```
+
+1. Install dependencies
+
+   ```bash
+   cd my-app
+   npm install
+   ```
+
+1. Copy example environment file
+
+   ```bash
+   cp example.env.local .env.local
+   ```
+
+1. Run development server
+
+   ```bash
+   npm run dev
+   ```
+
+## Production build
+
+1. Clone repository
+
+   ```bash
+   git clone --depth 1 https://github.com/brocoders/react-boilerplate.git my-app
+   ```
+
+1. Install dependencies
+
+   ```bash
+   cd my-app
+   npm install
+   ```
+
+1. Build application
+
+   ```bash
+   npm run build
+   ```
+
+1. Run production server
+
+   ```bash
+    npm run start
+    ```
+
+---
+
+Previous: [Introduction](introduction.md)
+
+Next: [Testing](testing.md)

docs/introduction.md

@@ -0,0 +1,21 @@
+# Introduction
+
+## Features
+
+- [x] Next.js
+- [x] TypeScript
+- [x] [i18n](https://react.i18next.com/) (based on https://github.com/i18next/next-13-app-dir-i18next-example)
+- [x] [Material UI](https://mui.com/)
+- [x] [React Hook Form](https://react-hook-form.com/)
+- [x] React Query
+- [x] Auth (Sign in, Sign up, Reset password, Confirm email, Refresh Token)
+- [x] File upload
+- [x] E2E tests (Cypress)
+- [x] ESLint
+- [x] CI (GitHub Actions)
+
+---
+
+Previous: [Main](README.md)
+
+Next: [Installing and Running](installing-and-running.md)

docs/testing.md

@@ -0,0 +1,33 @@
+# Testing
+
+---
+
+## Table of Contents <!-- omit in toc -->
+
+- [Testing](#testing)
+  - [Introduction](#introduction)
+  - [Running tests](#running-tests)
+
+---
+
+## Introduction
+
+This boilerplate uses [Cypress](https://www.cypress.io/) for E2E testing.
+
+## Running tests
+
+1. Run development server
+
+   ```bash
+   npm run dev
+   ```
+
+1. Run Cypress
+
+   ```bash
+    npx cypress open
+    ```
+
+---
+
+Previous: [Installing and Running](installing-and-running.md)

src/app/[language]/page.tsx

@@ -37,7 +37,7 @@ export default async function Home({ params }: Props) {
                   key="1"
                   target="_blank"
                   rel="noopener noreferrer"
-                  href="https://github.com/brocoders/react-boilerplate"
+                  href="https://github.com/brocoders/react-boilerplate/blob/main/docs/README.md"
                 >
                   {}
                 </MuiLink>,