docs: 📝 update `README.md`
by Sivritkin Dmitriy
1@@ -1,39 +1,90 @@
2-# GitCommitExplorer 🚀🔍
3+# [GitHub Commit Explorer](https://github-commit-explorer.vercel.app/)
4+
5+> 🐳 DEMO: https://github-commit-explorer.vercel.app/
6
7 Explore your Git commit history with ease! `GitHubCommitExplorer` is a sleek, real-time application that displays the commit history of its own repository. Built using the latest technologies like React, Typescript, Tailwind, and Next.js, it provides a detailed view of each commit with human-readable timestamps.
8
9+[](https://github-commit-explorer.vercel.app/)
10+
11 ## Features 🌟
12
13 - **Real-Time Updates**: Timestamps update live, without needing to refresh the page.
14 - **User-Friendly Interface**: Built with Tailwind for a responsive, intuitive design.
15 - **Refresh Button**: Fetch the latest commits without reloading the page, complete with a smooth loading indicator.
16+---
17+- ⚡ [Next.js](https://nextjs.org) with App Router support
18+- 🔥 Type checking [TypeScript](https://www.typescriptlang.org)
19+- 💎 Integrate with [Tailwind CSS](https://tailwindcss.com)
20+- 🎨 [Shadcn/UI](https://ui.shadcn.com/) reusable components built using [Radix UI](https://www.radix-ui.com/)
21+- ✅ Strict Mode for TypeScript and React 18
22+- 📏 Linter with [ESLint](https://eslint.org)
23+- 💖 Code Formatter with [Prettier](https://prettier.io)
24+- 🦊 Husky for Git Hooks
25+- 🚫 Lint-staged for running linters on Git staged files
26+- 🚓 Lint git commit with Commitlint
27+- 👷 Run checks with GitHub Actions - CI
28+- 💡 Absolute Imports using `~` prefix
29+- 🐳 [Docker](https://www.docker.com/) Integration
30+- 🌐 Deployed on [Vercel](https://vercel.com/)
31+- 🌙 Light/Dark Theme support
32
33-## Technologies Used 🛠️
34+## Running Locally
35
36-- React with TypeScript
37-- Tailwind CSS
38-- Next.js with App Router
39+1. Clone the repository
40+
41+```bash
42+git clone https://github.com/velenyx/systeme.io-task
43+```
44
45-## Setup and Deployment 📦
46+2. Install dependencies using yarn
47
48-Deployed with Vercel for seamless production performance and preview deployments. Check it out live at [GitHubCommitExplorer Live](#)!
49+```bash
50+corepack enable
51+yarn set version from sources
52+yarn
53+```
54
55-### Running Locally
56+3. Copy the `.env.example` to `.env` and update the variables.
57
58 ```bash
59-# Clone the repository
60-git clone https://github.com/yourusername/GitCommitExplorer.git
61+cp .env.example .env
62+```
63
64-# Install dependencies
65-cd GitCommitExplorer
66-npm install
67+4. Start the development server
68
69-# Run the application
70-npm run dev
71+```bash
72+yarn dev
73 ```
74
75-### Environment Variables
76+Open http://localhost:3000 with your favorite browser to see your project.
77+
78+### ⚙️ Environment Variables
79
80 To run this project, you will need to add the following environment variables to your .env.local file:
81
82 - `GITHUB_TOKEN` - Your GitHub Personal Access Token.
83+
84+## 🧞 Commands
85+
86+All commands are run from the root of the project, from a terminal:
87+
88+| Command | Action |
89+| :------------------------------- |:--------------------------------------------------|
90+| `corepack enable` | Enables Corepack to manage package managers |
91+| `yarn set version from sources` | Sets Yarn to the latest version from sources |
92+| `yarn install` | Installs dependencies |
93+| `yarn dev` | Starts the development server at `localhost:3000` |
94+| `yarn build` | Builds the application for production usage |
95+| `yarn start` | Starts a Node.js server for the production build |
96+| `yarn lint` | Runs the linter on the project files |
97+| `yarn lint:ts:check` | Checks ESLint errors |
98+| `yarn lint:ts:fix` | Fixes ESLint issues |
99+| `yarn format:check` | Checks formatting rules on all files |
100+| `yarn format:fix` | Applies formatting rules to all files |
101+| `yarn typecheck` | Performs a type check on TypeScript files |
102+| `yarn prepare` | Sets up Husky for git hooks |
103+
104+### ⭐ Show Your Support
105+If this test project has helped or inspired you, please consider giving it a 💫 on GitHub. Or, if you simply liked it, a star is also much appreciated!
106+
107+This section provides a friendly reminder to users about supporting the project, fostering a positive community interaction.