REST Client

Project description

This REST Client project aims to develop a light-weight versions of Postman. Key pages of the application include:

• Authorization and Registration pages 🖥️
• Main page 🏠
• REST Client page 📋
• Variables
• History

The project is being developed as the final task of the RS school's JS / React course. Its main goals are:

• consolidation of the knowledges gained during this course and,
• improvement of teamwork skills.

Our team:

• antonina220590
• gbogdanova
• tatidem

Technology stack

Front-end:

• HTML
• TailwindCss
• TypeScript
• Webpack
• React
• Next JS
• Vitest
• Firebase

Getting Started

Install dependencies:

npm install

Run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Build the application:

npm run build

Compiles the application for production deployment. It optimizes the app for the best performance.

Start the application in production mode

npm run start

Starts the server in production mode. Must be used after building the app.

Lint the project files

npm run lint

Runs ESLint to find and fix problems in your JavaScript and TypeScript files within the app/ directory.

Format the project files

npm run prettier:fix

Runs Prettier to format code.

Run Tests

npm run test

Executes the test suites of the application using Vitest.

Run Tests Coverage

npm run test:coverage

Executes the test coverage.

REST Requests Examples

GET

##### endpoint url:
https://rickandmortyapi.com/api/character


##### headers (optional)

Content-Type: application/json

##### queries (optional)

key: name
value: Rick

POST

##### endpoint url:
https://jsonplaceholder.typicode.com/posts

##### body:

{
  "title": "foo",
  "body": "bar",
  "userId": 1
}

##### headers

Content-Type: application/json

PUT

##### endpoint url:

 https://jsonplaceholder.typicode.com/posts/1

##### body:

{
  "id": 1,
  "title": "UPDATED Title Example",
  "body": "This is the updated body content.",
  "userId": 1
}

##### headers

Content-Type: application/json

GET with VARIBALES

##### endpoint url:

URL: {{baseUrl}}/posts/{{postId}}


##### Variables

key: baseUr  value: https://jsonplaceholder.typicode.com
key: postId  value: 2

##### headers

Content-Type: application/json