REST Client

.env.example

@@ -0,0 +1,4 @@
+# Supabase Configuration
+# Get these values from your Supabase Dashboard -> Settings -> API
+NEXT_PUBLIC_SUPABASE_URL=https://your-project-id.supabase.co
+NEXT_PUBLIC_SUPABASE_ANON_KEY=your-legacy-api-key-here

.github/CODEOWNERS

@@ -0,0 +1 @@
+@Sepulator @anastanei @SpaNb4 @IlinJoy

.github/pull_request_template.md

@@ -0,0 +1,22 @@
+# Type of PR 🍩
+
+- [ ] Feature
+- [ ] Bugfix
+- [ ] Hotfix
+- [ ] Refactoring
+- [ ] Documentation
+- [ ] Infrastructure
+
+## Changes Introduced 🥯
+
+- Implemented: [feature name] (mention addition functionality if relevant)
+- Refactored: [Component/Module] (explain reasoning if significant)
+- Fixed: [Bug description] (include error references if applicable)
+- Updated: [Documentation/Configuration] (specify locations)
+
+### Self-Check ✅
+
+- [ ] No console errors (except API requests)
+- [ ] 80%+ test coverage
+- [ ] Documentation updated (if relevant)
+- [ ] Package.json scripts updated (if relevant)

.github/workflows/add-reviewers.yml

@@ -0,0 +1,38 @@
+name: Add reviewers
+on:
+  pull_request:
+    types: [opened, ready_for_review, synchronize]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  add-reviews:
+    runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.draft }}
+    steps:
+      - uses: actions/github-script@v7.0.1
+        with:
+          script: |
+            try {
+              const {user, requested_reviewers} = context.payload.pull_request
+              const author = user.login;
+
+              const reviewers = ['Sepulator', 'anastanei', 'SpaNb4', 'IlinJoy'];
+              const existingReviewers = requested_reviewers.map(reviewer => reviewer.login);
+
+              const newReviewers = reviewers.filter(reviewer =>
+                reviewer !== author && !existingReviewers.includes(reviewer)
+              );
+
+              if (newReviewers.length) {
+                await github.rest.pulls.requestReviewers({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  pull_number: context.issue.number,
+                  reviewers: newReviewers
+                });
+              }
+            } catch (error) {
+              console.error(error.message);
+            }

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - develop
+
+env:
+  NODE_VERSION: 22.x
+
+jobs:
+  run-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get repo code
+        uses: actions/checkout@v5
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4.4.0
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - uses: bahmutov/npm-install@v1
+
+      - name: Run formatter
+        run: npm run format:check
+
+      - name: Run typegen
+        run: npm run type
+
+      - name: Run linter
+        run: npm run lint
+
+      - name: Run tests
+        run: npm run test

.gitignore

@@ -0,0 +1,42 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+!.env.example
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.husky/pre-push

@@ -0,0 +1 @@
+npm run test && npm run lint && npm run type-check

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 120,
+  "semi": true,
+  "arrowParens": "always",
+  "plugins": ["prettier-plugin-tailwindcss"]
+}

.stylelintignore

@@ -0,0 +1,2 @@
+dist
+node_modules

.vscode/extensions.json

@@ -0,0 +1,12 @@
+{
+  "recommendations": [
+    // ESLint/Prettier formatter
+    "esbenp.prettier-vscode",
+    // ESLint support to VSCode
+    "dbaeumer.vscode-eslint",
+    // Tailwind CSS autocomplete and more
+    "bradlc.vscode-tailwindcss",
+    // Testing
+    "vitest.explorer"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,22 @@
+{
+  // Formatting using Prettier by default for all languages
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  // Formatting using Prettier for JavaScript, overrides VSCode default.
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  // Linting using ESLint.
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
+  // Tell VS Code to always open .css files in Tailwind CSS mode:
+  "files.associations": {
+    "*.css": "tailwindcss"
+  },
+  //Fix eslint auto-fixable problems on save a file
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit"
+  },
+  "eslint.useFlatConfig": true,
+  // Ensure enough terminal history is preserved when running tests.
+  "terminal.integrated.scrollback": 10000,
+  "cSpell.words": ["heroui"]
+}

README.md

@@ -1 +1,130 @@
-# rest-client-app
+# REST Client 🌐
+
+Welcome to our `REST Client` application! This lightweight alternative to Postman combines essential features in one app.
+Supports authorization and authentication capabilities. Access to the tool is restricted to authorized users only.
+The history section provides quick access to previously executed requests 🚀.
+Full task description [rest client](https://github.com/rolling-scopes-school/tasks/blob/master/react/modules/tasks/final.md)
+
+## Features
+
+Key pages in the application include:
+
+- Login and Registration pages 👤
+- Main page 🏠
+- RESTful client 🖥️, which includes:
+  - method selector
+  - text input for the endpoint URL
+  - request editor
+  - headers editor
+  - response section
+  - generated code section
+- Variables 🔎
+- History 📋
+
+The application is developed in teams of three 👩‍💻👩‍💻👨‍💻 [Maria Ilina](https://github.com/IlinJoy), [Anastasiia Nikonova](https://github.com/anastanei), [Yuri S.](https://github.com/Sepulator).
+
+## Tech-stack
+
+- ⚡ [Next.js](https://nextjs.org/): The React Framework for the Web.
+- 💪 [Strongly typed](https://www.typescriptlang.org/): Uses TypeScript.
+- 🔥 [HeroUI](https://www.heroui.com/): Beautiful, fast and modern React UI library.
+- 🤖 [Valibot](https://valibot.dev/): The modular and type safe schema library.
+- 🎊 [Tailwind](https://tailwindcss.com/): Rapidly build modern websites without ever leaving your HTML.
+- ⌨️ [Testing framework](https://vitest.dev/): Vitest to test the code base. It's fast!
+- 🛍️ [Supabase](https://supabase.com/): The Postgres development platform.
+- 🐒 [React CodeMirror](https://uiwjs.github.io/react-codemirror/): CodeMirror component for React.
+- 📝 [React Hook Form](https://react-hook-form.com/): Performant, flexible and extensible forms with easy-to-use validation.
+- 🐻 [Zustand](https://zustand-demo.pmnd.rs/): small, fast, and scalable bearbones state management solution.
+
+## Getting Started
+
+### Steps
+
+#### 0. Supabase Configuration
+
+- Get `Project URL` and `API Key` from Supabase Dashboard -> Project Overview -> Project API.
+- Rename `.env.example` to `.env` and copy `Project URL` with `API Key`.
+- Turn off `Confirm email` in Supabase Dashboard -> Authentication -> Sign In / Providers.
+
+```dotenv copy
+NEXT_PUBLIC_SUPABASE_URL=https://your-project-id.supabase.co
+NEXT_PUBLIC_SUPABASE_ANON_KEY=your-legacy-api-key-here
+```
+
+#### 1. Clone [repository](https://github.com/Sepulator/rest-client-app)
+
+```bash copy
+  git clone https://github.com/Sepulator/rest-client-app.git
+```
+
+#### 2. Open project directory and install dependencies
+
+```bash copy
+  npm install
+```
+
+#### 3. Start the development server
+
+```bash copy
+  npm run dev
+```
+
+This command starts the dev server locally `http://localhost:3000/`.
+
+### Available scripts
+
+#### Build for production
+
+```bash copy
+  npm run build
+```
+
+---
+
+#### Start Vite dev server in the current directory
+
+```bash copy
+  npm run dev
+```
+
+---
+
+#### Run ESLint to fix errors
+
+```bash copy
+  npm run lint
+```
+
+---
+
+#### Run unit test
+
+```bash copy
+  npm run test
+```
+
+---
+
+#### Unit test coverage
+
+```bash copy
+  npm run test:coverage
+```
+
+---
+
+#### Run code format with Prettier
+
+```bash copy
+  npm run format
+```
+
+---
+
+#### Run husky to prepare git hooks
+
+```bash copy
+  npm run prepare
+```
+
+---