Skip to content

docs: update readme #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sepulator merged 2 commits into from
Sep 21, 2025
Merged

docs: update readme #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8406caa
docs: update readme
Sepulator Sep 21, 2025
df1da19
docs: revert .env ignore pattern
Sepulator Sep 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
!.yarn/plugins
!.yarn/releases
!.yarn/versions
!.env.example

# testing
/coverage
Expand Down
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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 [here](https://github.com/rolling-scopes-school/tasks/blob/master/react/modules/tasks/final.md)
Full task description [rest client](https://github.com/rolling-scopes-school/tasks/blob/master/react/modules/tasks/final.md)

## Features

Expand All @@ -21,7 +21,7 @@ Key pages in the application include:
- Variables 🔎
- History 📋

The application is developed in teams of three 👩‍💻👩‍💻👨‍💻 [Yuri S.](https://github.com/Sepulator), [Maria Ilina](https://github.com/IlinJoy), [Anastasiia Nikonova](https://github.com/anastanei).
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

Expand All @@ -32,11 +32,25 @@ The application is developed in teams of three 👩‍💻👩‍💻👨‍💻
- 🎊 [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
Expand Down