Skip to content

Commit

Permalink
README actualizado
Browse files Browse the repository at this point in the history
  • Loading branch information
David Solanas authored and David Solanas committed May 29, 2019
1 parent b8fdad0 commit 6dec7a7
Showing 1 changed file with 27 additions and 54 deletions.
81 changes: 27 additions & 54 deletions app/README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,41 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# proyecto_software_web

## Available Scripts
## Instalación

In the project directory, you can run:
1. Descargar e instalar `Node.js y npm` desde [aquí](https://www.npmjs.com/get-npm)
2. Clonar el proyecto.
3. `cd proyecto_software_web/app`
4. Ejecutar `npm install`para descargar todos los paquetes y dependencias automáticamente.

### `npm start`
## Empezar a desarrollar

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
1. `cd proyecto_software_web/app`
2. Ejecutar `npm start`

The page will reload if you make edits.<br>
You will also see any lint errors in the console.
## Instalar librerías

### `npm test`
1. `cd proyecto_software_web/app`
2. Buscar en `https://www.npmjs.com` la librería correspondiente.
3. Comprobar compatibilidad.
4. Instalar la librería ejecutando `npm install {librería} --save`

Launches the test runner in the interactive watch mode.<br>
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
## Generar documentación automática de la aplicación

### `npm run build`
1. `cd proyecto_software_web/app`
2. `npm run doc`

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.
## Generar versión compilada de la aplicación

The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
1. `cd proyecto_software_web/app`
2. `npm run build`

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
## Documentación y pruebas de la api

### `npm run eject`
1. Ir a `https://swagger.io/tools/swagger-ui/` y pulsar sobre **Live Demo**.
2. Cambiar la url de https a http.
3. Poner `https://raw.githubusercontent.com/unizar-30226-2019-03/proyecto_software_backend/master/api_docs/api-spec.yml` en la barra de explorar.
4. Ahora se puede ver la documentacion de la api (ejemplos de respuesta de métodos, parámetros de funciones etc) y ejecutar métodos en la api directamente en el buscador (añadir nuevos usuarios, asignaturas etc.)

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
## Clonar

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

### Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

### Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

### Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

### Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

### `npm run build` fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
Clonar el repositorio ejecutando `git clone https://github.com/unizar-30226-2019-03/proyecto_software_web.git`

0 comments on commit 6dec7a7

Please sign in to comment.