Skip to content

Sepulator/rest-client-app

Repository files navigation

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

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, Anastasiia Nikonova, Yuri S..

Tech-stack

  • Next.js: The React Framework for the Web.
  • 💪 Strongly typed: Uses TypeScript.
  • 🔥 HeroUI: Beautiful, fast and modern React UI library.
  • 🤖 Valibot: The modular and type safe schema library.
  • 🎊 Tailwind: Rapidly build modern websites without ever leaving your HTML.
  • ⌨️ Testing framework: Vitest to test the code base. It's fast!
  • 🛍️ Supabase: The Postgres development platform.
  • 🐒 React CodeMirror: CodeMirror component for React.
  • 📝 React Hook Form: Performant, flexible and extensible forms with easy-to-use validation.
  • 🐻 Zustand: 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.
NEXT_PUBLIC_SUPABASE_URL=https://your-project-id.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-legacy-api-key-here

1. Clone repository

  git clone https://github.com/Sepulator/rest-client-app.git

2. Open project directory and install dependencies

  npm install

3. Start the development server

  npm run dev

This command starts the dev server locally http://localhost:3000/.

Available scripts

Build for production

  npm run build

Start Vite dev server in the current directory

  npm run dev

Run ESLint to fix errors

  npm run lint

Run unit test

  npm run test

Unit test coverage

  npm run test:coverage

Run code format with Prettier

  npm run format

Run husky to prepare git hooks

  npm run prepare

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •