📋 Customer Manager

Welcome to the Customer Manager project! 🚀 This simple Proof of Concept (POC), showcasing basic CRUD functionalities for managing customers.

The backend code can be seem in the following repository.

⚙️ Project Setup

Before running the project, it is necessary to have npm and node installed on your machine.

Note

ℹ️ System Information:

npm ~> v9.8.1
node ~> v18.18.2

Warning

⚠️ Important Note:
It is crucial to mention that this project locally utilizes pnpm (v8.9.2) instead of npm, although both should be able to interoperate without any issues.

After checking or installing node and npm on your machine it is necessary to clone the git repository of the frontend with the following command:

$ git clone https://github.com/LuigiVanin/customer-manager-sample.git

After all, ensure to create an .env file following the structure outlined in .env.example. This file should contain all necessary environment variables for the application to function properly.

Variable	Description
VITE_API_URL	The URL of the API endpoint that the frontend consumes. For local development, it is set to `http://localhost:5138/`. Ensure it points to the correct API server address.

🚀 How to Run the Frontend

Firstly, it's necessary to install all project dependencies using npm:

$ npm i

To run the project in development mode, use the following command:

$ npm run dev

🛠️ How to Build the Project

To build the project, execute the following command:

$ npm run build

Folder Structure

src/components: This directory may contain reusable components that can be used in various parts of the application.
src/pages: Specific page components will be placed here. Each page may have its own directory with components, styles, etc.
src/pages/layouts: Folder designated for page layouts.
src/services: Shared services will be placed here. Services are used for business logic, communication with APIs, etc.
src/lib: This directory may contain shared resources.
src/hooks: Files related to React hooks will be maintained here.
src/types: Specific types for this application will be kept here.
src/providers: This folder will contain all custom context providers for global contexts.

luigivanin / customer-manager-sample Goto Github PK