Skip to content
Snippets Groups Projects
Commit 13587dcc authored by safarte's avatar safarte
Browse files

readme

parent 4cef50eb
No related branches found
No related tags found
No related merge requests found
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). # Formation React
## Available Scripts By Safarte and Soudini
In the project directory, you can run: ## Install
### `yarn start` * Install NodeJS
* Install yarn
* Run:
Runs the app in the development mode.<br /> ```bash
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. git clone https://gitlab.viarezo.fr/LinkCS/react-tutorial-front.git
cd react-tutorial-front
yarn install
```
The page will reload if you make edits.<br /> ## Usage
You will also see any lint errors in the console.
### `yarn test` You need to complete the code if you want the website to work properly !
Launches the test runner in the interactive watch mode.<br /> To run this website locally execute `yarn start` in the working directory.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn build` ## API
Builds the app for production to the `build` folder.<br /> `GET /users => [Object]` -> Lists all users
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.<br /> `GET /users/id => Object` -> Get the info about the user with asked id
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. `GET /boards => [Object]` -> Lists all boards
### `yarn eject` `GET /boards/id => Object` -> Get the info about the board with asked id
**Note: this is a one-way operation. Once you `eject`, you can’t go back!** `GET /messages?board=id => [Object]` -> Get the messages from the board with asked id
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. To post a message from specified user on specified board:
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. ```json
POST /messages
body:
{
"content": "blabla",
"userId": 42,
"boardId": 1
}
```
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. To register a new user (returns the user):
## Learn More ```json
POST /users => Object
body:
{
"username": "henry",
"paswword": "verysecure"
}
```
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). To login an user (returns a list containing the matching users):
To learn React, check out the [React documentation](https://reactjs.org/). ```json
POST /login => [Object]
### Code Splitting body:
{
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting "username": "henry",
"paswword": "verysecure"
### 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
### `yarn build` fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment