https://github.com/igafar/scan-react

Web application for searching company information by TIN
https://github.com/igafar/scan-react

ant-design husky linter prettier react react-router redux-toolkit rtk-query sonner styled-components typescript webpack

Last synced: 2 months ago
JSON representation

Web application for searching company information by TIN

• Host: GitHub
• URL: https://github.com/igafar/scan-react
• Owner: iGafar
• Created: 2025-02-07T21:43:00.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-02-25T19:38:50.000Z (8 months ago)
• Last Synced: 2025-02-25T20:34:13.023Z (8 months ago)
• Topics: ant-design, husky, linter, prettier, react, react-router, redux-toolkit, rtk-query, sonner, styled-components, typescript, webpack
• Language: TypeScript
• Homepage:
• Size: 1.07 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Scan

`Scan` is a web application for searching company information by TIN

[`Application link`](https://igafar.github.io/scan-react) 

`Use login: aleksey; password: 4i2385j`

## 👨‍💻 Technology Stack

![Typescript](https://img.shields.io/badge/TypeScript-3178C6.svg?style=for-the-badge&logo=TypeScript&logoColor=white)

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)

![Redux](https://img.shields.io/badge/redux-%23593d88.svg?style=for-the-badge&logo=redux&logoColor=white)

![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)

![Ant-Design](https://img.shields.io/badge/-AntDesign-%230170FE?style=for-the-badge&logo=ant-design&logoColor=white)

![Styled Components](https://img.shields.io/badge/styled--components-DB7093?style=for-the-badge&logo=styled-components&logoColor=white)

![Webpack](https://img.shields.io/badge/webpack-%238DD6F9.svg?style=for-the-badge&logo=webpack&logoColor=black)

![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)

![Prettier](https://img.shields.io/badge/prettier-%23F7B93E.svg?style=for-the-badge&logo=prettier&logoColor=black)

![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)

![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)

![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)

## 📝 Architecture

[Atomic Desigm](https://atomicdesign.bradfrost.com/chapter-2/)

## 🔗 Useful links

- [Naming rules](./docs/naming-rules.md)

- [Сommit naming rules](https://www.conventionalcommits.org/en/v1.0.0/)

## 🏃 Getting Started

`Required Node.js version 21.4 and higher!`

To get a local copy of the project perform the following actions:

1. Clone the repo

```

git clone https://github.com/iGafar/scan-react.git

```

2. Install npm packages

```

npm install

```

3. Run the project locally

```

npm run dev

```

## 📜 Available scripts

#### Webpack (code building)

- build production version

```

npm run build

```