Overview

The react-rest-api-typescript-boilerplate is a project template that aims to provide a well-structured and organized foundation for building React applications with TypeScript. The template includes various folders and components that follow specific guidelines and conventions for their usage. By adhering to this structure, developers can ensure consistency and maintainability throughout their projects.

Features

• Pages: A folder containing components that form the pages of the application. These components can utilize various other types of components in their implementation.

• Containers: Container components that can use services and custom hooks. They may also use other types of components in their implementation.

• Components: This folder is further divided into subfolders:

  • Smart: Contains smart components that can use the repository and custom hooks but cannot use services. They can use other types of components.

  • Ordinary: Stores complex components that cannot use the repository or custom hooks. They can use Simple and UI components.

  • Simple: Stores auxiliary components that should not use any custom hooks or repository. They can use UI components.

  • UI: Contains components that replace native components. They may contain logic using hooks and storage.

• Core: This folder contains the logical part of the project, including services and configuration files.

• Config: Contains configuration files, such as server URIs and limits/patterns/routes.

• Constants: Contains constants, such as messages, units, and mime-types.

• Hooks: Contains custom hooks.

• Models: Contains models that come from the API server. Descriptions of attached models should be done in the response type of the corresponding service.

• Schemes: Contains table schemes or form schemes.

• Services: Stores services for API server communication.

• Store: Stores store context and global store schemes (if used with MobX).

• Theme (for styled-components): Stores the project’s theme(s).

• Types: Stores all domain types.

• Utils: Stores auxiliary functions.

Installation

To install the react-rest-api-typescript-boilerplate, follow these steps:

1. Clone the repository:

git clone [repository-url]

2. Navigate to the project directory:

cd react-rest-api-typescript-boilerplate

3. Install dependencies:

npm install

4. Start the development server:

npm start

Summary

The react-rest-api-typescript-boilerplate provides a well-structured and organized foundation for building React applications with TypeScript. It follows a specific folder structure and provides guidelines for the usage of different types of components. By using this boilerplate, developers can ensure consistency and maintainability in their projects.