Skip to content

wingedseraph/rest-client-app

Repository files navigation

██████╗ ███████╗███████╗████████╗             ██████╗██╗     ██╗███████╗███╗   ██╗████████╗
██╔══██╗██╔════╝██╔════╝╚══██╔══╝            ██╔════╝██║     ██║██╔════╝████╗  ██║╚══██╔══╝
██████╔╝█████╗  ███████╗   ██║               ██║     ██║     ██║█████╗  ██╔██╗ ██║   ██║   
██╔══██╗██╔══╝  ╚════██║   ██║               ██║     ██║     ██║██╔══╝  ██║╚██╗██║   ██║   
██║  ██║███████╗███████║   ██║               ╚██████╗███████╗██║███████╗██║ ╚████║   ██║   
╚═╝  ╚═╝╚══════╝╚══════╝   ╚═╝                ╚═════╝╚══════╝╚═╝╚══════╝╚═╝  ╚═══╝   ╚═╝           
image

A light-weight version of Postman, open‑source API client built with:

  • Next.js (App Router)
  • React Hook Form
  • Zod
  • Tailwind CSS
  • shadcn/ui
  • Firebase Cloud DB

Getting Started

Prerequisites

  • Node.js
  • pnpm

Installation

pnpm install

Environment Setup

Create a .env file in the root directory and add your Firebase configuration:

cp .env.example .env

Note: The example Firebase config is for our database. You need to register your own Firebase project and get the environment variables yourself.

Required environment variables:

  • NEXT_PUBLIC_FIREBASE_API_KEY
  • NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN
  • NEXT_PUBLIC_FIREBASE_PROJECT_ID
  • NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET
  • NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID
  • NEXT_PUBLIC_FIREBASE_APP_ID

Running Locally

pnpm dev

Open http://localhost:3000 in your browser.

Available Scripts

  • pnpm dev - Start development server
  • pnpm build - Build for production
  • pnpm lint - Run Biome lint
  • pnpm format - Format code with Biome
  • pnpm test - Run tests

Team

About

An application REST Client for the RS School education process

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors