Skip to content

Update getting-started.md #17115

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

Closed
wants to merge 1 commit into from
+130 −162
Closed

Update getting-started.md #17115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
292 changes: 130 additions & 162 deletions docusaurus/docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,162 +1,130 @@
---
id: getting-started
title: Getting Started
---

Create React App is an officially supported way to create single-page React
applications. It offers a modern build setup with no configuration.

## Quick Start

```sh
npx create-react-app my-app
cd my-app
npm start
```

> If you've previously installed `create-react-app` globally via `npm install -g create-react-app`, we recommend you uninstall the package using `npm uninstall -g create-react-app` or `yarn global remove create-react-app` to ensure that `npx` always uses the latest version.

_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_

Then open [http://localhost:3000/](http://localhost:3000/) to see your app.

When you’re ready to deploy to production, create a minified bundle with `npm run build`.

<p align='center'>
<img src='https://cdn.jsdelivr.net/gh/facebook/create-react-app@27b42ac7efa018f2541153ab30d63180f5fa39e0/screencast.svg' width='600' alt='npm start' />
</p>

### Get Started Immediately

You **don’t** need to install or configure tools like webpack or Babel. They are preconfigured and hidden so that you can focus on the code.

Create a project, and you’re good to go.

## Creating an App

**You’ll need to have Node >= 14 on your local development machine** (but it’s not required on the server). You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to switch Node versions between different projects.

To create a new app, you may choose one of the following methods:

### npx

```sh
npx create-react-app@latest my-app
```

_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_

### npm

```sh
npm init react-app my-app
```

_`npm init <initializer>` is available in npm 6+_

### Yarn

```sh
yarn create react-app my-app
```

_`yarn create` is available in Yarn 0.25+_

### Selecting a template

You can now optionally start a new app from a template by appending `--template [template-name]` to the creation command.

If you don't select a template, we'll create your project with our base template.

Templates are always named in the format `cra-template-[template-name]`, however you only need to provide the `[template-name]` to the creation command.

```sh
npx create-react-app my-app --template [template-name]
```

> You can find a list of available templates by searching for ["cra-template-\*"](https://www.npmjs.com/search?q=cra-template-*) on npm.

Our [Custom Templates](custom-templates.md) documentation describes how you can build your own template.

#### Creating a TypeScript app

You can start a new TypeScript app using templates. To use our provided TypeScript template, append `--template typescript` to the creation command.

```sh
npx create-react-app my-app --template typescript
```

If you already have a project and would like to add TypeScript, see our [Adding TypeScript](adding-typescript.md) documentation.

### Selecting a package manager

When you create a new app, the CLI will use [npm](https://docs.npmjs.com) or [Yarn](https://yarnpkg.com/) to install dependencies, depending on which tool you use to run `create-react-app`. For example:

```sh
# Run this to use npm
npx create-react-app my-app
# Or run this to use yarn
yarn create react-app my-app
```

## Output

Running any of these commands will create a directory called `my-app` inside the current folder. Inside that directory, it will generate the initial project structure and install the transitive dependencies:

```
my-app
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── public
│ ├── favicon.ico
│ ├── index.html
│ ├── logo192.png
│ ├── logo512.png
│ ├── manifest.json
│ └── robots.txt
└── src
├── App.css
├── App.js
├── App.test.js
├── index.css
├── index.js
├── logo.svg
├── serviceWorker.js
└── setupTests.js
```

No configuration or complicated folder structures, only the files you need to build your app. Once the installation is done, you can open your project folder:

```sh
cd my-app
```

## Scripts

Inside the newly created project, you can run some built-in commands:

### `npm start` or `yarn start`

Runs the app in development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will automatically reload if you make changes to the code. You will see the build errors and lint warnings in the console.

<p align='center'>
<img src='https://cdn.jsdelivr.net/gh/marionebl/create-react-app@9f6282671c54f0874afd37a72f6689727b562498/screencast-error.svg' width='600' alt='Build errors' />
</p>

### `npm test` or `yarn test`

Runs the test watcher in an interactive mode. By default, runs tests related to files changed since the last commit.

[Read more about testing](running-tests.md).

### `npm run build` or `yarn build`

Builds the app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed.
// App.js
import React, { useState, useEffect } from 'react';

// Main App component for the CRM Client List
function App() {
// State to hold the list of clients
const [clients, setClients] = useState([]);
// State for the search term entered by the user
const [searchTerm, setSearchTerm] = useState('');
// State for loading status (simulated)
const [isLoading, setIsLoading] = useState(true);

// Simulate fetching client data from an API
useEffect(() => {
// Mock client data
const mockClients = [
{ id: '1', name: 'Reformas del Sol S.L.', contactPerson: 'Juan García', email: 'juan.garcia@reformasdelsol.es', phone: '+34 600 123 456', project: 'Reforma Integral Cocina' },
{ id: '2', name: 'Constructora Atlántica', contactPerson: 'María Pérez', email: 'maria.perez@constructora.es', phone: '+34 610 234 567', project: 'Aislamiento Térmico Fachada' },
{ id: '3', name: 'Innovación Hogar S.A.', contactPerson: 'Carlos Ruiz', email: 'carlos.ruiz@innovacionhogar.com', phone: '+34 620 345 678', project: 'Ampliación Salón' },
{ id: '4', name: 'Reformas Compostela', contactPerson: 'Ana López', email: 'ana.lopez@reformascompostela.es', phone: '+34 630 456 789', project: 'Reforma Baño Principal' },
{ id: '5', name: 'Grupo Edifica Galicia', contactPerson: 'Pablo Martínez', email: 'pablo.martinez@grupoedifica.es', phone: '+34 640 567 890', project: 'Impermeabilización Cubierta' },
{ id: '6', name: 'Arquitectura Viva', contactPerson: 'Laura Fernández', email: 'laura.fernandez@arq-viva.es', phone: '+34 650 678 901', project: 'Diseño y Construcción Jardín' },
{ id: '7', name: 'Soluciones Constructivas Norte', contactPerson: 'David Castro', email: 'david.castro@solucionesnorte.es', phone: '+34 660 789 012', project: 'Rehabilitación Edificio Histórico' },
{ id: '8', name: 'Reforma Express', contactPerson: 'Elena Gómez', email: 'elena.gomez@reformaexpress.es', phone: '+34 670 890 123', project: 'Cambio de Ventanas' },
{ id: '9', name: 'Hogar Confort S.L.', contactPerson: 'Javier Santos', email: 'javier.santos@hogarconfort.es', phone: '+34 680 901 234', project: 'Instalación de Calefacción' },
{ id: '10', name: 'Acabados Premium Galicia', contactPerson: 'Sofía Torres', email: 'sofia.torres@acabadospremium.es', phone: '+34 690 012 345', project: 'Pulido y Barnizado de Suelos' },
];

setTimeout(() => {
setClients(mockClients);
setIsLoading(false);
}, 1000); // Simulate network delay
}, []);

// Filter clients based on the search term
const filteredClients = clients.filter(client =>
client.name.toLowerCase().includes(searchTerm.toLowerCase()) ||
client.contactPerson.toLowerCase().includes(searchTerm.toLowerCase()) ||
client.email.toLowerCase().includes(searchTerm.toLowerCase())
);

return (
<div className="min-h-screen bg-gray-100 font-inter p-4 sm:p-6 lg:p-8 flex flex-col items-center">
<div className="w-full max-w-6xl bg-white rounded-xl shadow-lg p-6 sm:p-8">
<h1 className="text-3xl sm:text-4xl font-bold text-gray-800 mb-6 text-center">Gestión de Clientes CRM</h1>

{/* Search input section */}
<div className="mb-6">
<input
type="text"
placeholder="Buscar clientes por nombre, contacto o email..."
className="w-full p-3 sm:p-4 border border-gray-300 rounded-lg focus:ring-blue-500 focus:border-blue-500 transition duration-200 ease-in-out text-base sm:text-lg"
value={searchTerm}
onChange={(e) => setSearchTerm(e.target.value)}
aria-label="Campo de búsqueda de clientes"
/>
</div>

{/* Loading state */}
{isLoading ? (
<div className="text-center text-lg sm:text-xl text-gray-600 p-8">Cargando clientes...</div>
) : (
<>
{/* Desktop Table View (for larger screens) */}
<div className="hidden md:block overflow-x-auto">
<table className="min-w-full bg-white border border-gray-200 rounded-lg">
<thead className="bg-blue-600 text-white rounded-t-lg">
<tr>
<th className="py-3 px-4 text-left text-sm font-semibold rounded-tl-lg">ID</th>
<th className="py-3 px-4 text-left text-sm font-semibold">Empresa</th>
<th className="py-3 px-4 text-left text-sm font-semibold">Persona de Contacto</th>
<th className="py-3 px-4 text-left text-sm font-semibold">Email</th>
<th className="py-3 px-4 text-left text-sm font-semibold">Teléfono</th>
<th className="py-3 px-4 text-left text-sm font-semibold rounded-tr-lg">Proyecto Asignado</th>
</tr>
</thead>
<tbody>
{filteredClients.length > 0 ? (
filteredClients.map((client) => (
<tr key={client.id} className="border-b border-gray-200 hover:bg-gray-50 transition duration-150 ease-in-out">
<td className="py-3 px-4 text-sm text-gray-700">{client.id}</td>
<td className="py-3 px-4 text-sm font-medium text-blue-700">{client.name}</td>
<td className="py-3 px-4 text-sm text-gray-700">{client.contactPerson}</td>
<td className="py-3 px-4 text-sm text-gray-700">{client.email}</td>
<td className="py-3 px-4 text-sm text-gray-700">{client.phone}</td>
<td className="py-3 px-4 text-sm text-gray-700">{client.project}</td>
</tr>
))
) : (
<tr>
<td colSpan="6" className="py-6 text-center text-gray-500 text-base">
No se encontraron clientes que coincidan con la búsqueda.
</td>
</tr>
)}
</tbody>
</table>
</div>

{/* Mobile Card View (for smaller screens) */}
<div className="md:hidden">
{filteredClients.length > 0 ? (
<div className="grid grid-cols-1 gap-4">
{filteredClients.map((client) => (
<div key={client.id} className="bg-white border border-gray-200 rounded-lg shadow-sm p-4 hover:shadow-md transition duration-150 ease-in-out">
<div className="flex items-center justify-between mb-2">
<h3 className="text-lg font-bold text-blue-700">{client.name}</h3>
<span className="text-sm text-gray-500 bg-gray-100 px-2 py-1 rounded-full">ID: {client.id}</span>
</div>
<p className="text-sm text-gray-700 mb-1">**Contacto:** {client.contactPerson}</p>
<p className="text-sm text-gray-700 mb-1">**Email:** {client.email}</p>
<p className="text-sm text-gray-700 mb-1">**Teléfono:** {client.phone}</p>
<p className="text-sm text-gray-700">**Proyecto:** {client.project}</p>
</div>
))}
</div>
) : (
<div className="text-center text-base text-gray-500 p-6 bg-white rounded-lg shadow-sm">
No se encontraron clientes que coincidan con la búsqueda.
</div>
)}
</div>
</>
)}
</div>
</div>
);
}

export default App;