Skip to content

Commit 9593ee3

Browse files
committed
Update README.md
1 parent 2a0f969 commit 9593ee3

File tree

1 file changed

+41
-25
lines changed

1 file changed

+41
-25
lines changed

README.md

Lines changed: 41 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,44 @@
1-
This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
1+
### Integrating React Native into the Yaku Project
22

3-
# Getting Started
3+
The Yaku project leverages React Native to develop a cross-platform mobile application, thus enabling a seamless user
4+
experience on both iOS and Android. React Native simplifies the creation of responsive user interfaces and access to an
5+
extensive library of components, which is crucial for providing features such as food product search, display of
6+
nutritional information, and tracking of dietary intake. The use of React Native supports our goal of making the Yaku
7+
application accessible to a wide audience by harnessing its ability to rapidly develop high-performing applications for
8+
various platforms.
49

5-
>**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.
10+
### Used API
11+
12+
To retrieve information about food products, we utilize the OpenFoodTracks API. This API grants us access to a vast
13+
database containing detailed information about food products, including their nutritional composition, ingredients,
14+
labels, and nutritional values.
15+
16+
Example request to retrieve information about a specific product by its barcode:
17+
18+
```bash
19+
curl -X GET "https://fr.openfoodfacts.org/api/v0/produit/[barcode].json"
20+
```
21+
22+
For further information about food products, we use the OpenFoodTracks API. This API provides us access to a
23+
comprehensive database containing detailed information about food products, including their nutritional composition,
24+
ingredients, labels, and nutritional values. To explore the API documentation and view usage examples,
25+
visit [OpenFoodFacts](https://fr.openfoodfacts.org).
26+
27+
### Key Features
28+
29+
- Search for food products by name, brand, or category.
30+
- Display detailed nutritional information for each product.
31+
- Track daily and historical dietary intake.
32+
- Receive suggestions for similar or alternative products.
33+
- Create shopping lists and track food purchases.
34+
- Technologies Used
35+
36+
### Technologies Used
37+
38+
- The Yaku project is primarily developed using modern web technologies such as React Native.
39+
40+
For more information about the project and its development, feel free to check out our GitHub repository and contribute
41+
if you're interested!
642

743
## Step 1: Start the Metro Server
844

@@ -17,7 +53,8 @@ npm start
1753

1854
## Step 2: Start your Application
1955

20-
Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app:
56+
Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the
57+
following command to start your _Android_ or _iOS_ app:
2158

2259
### For Android
2360

@@ -38,24 +75,3 @@ npm run ios
3875
# OR using Yarn
3976
yarn ios
4077
```
41-
42-
### Yaku Project
43-
The Yaku project is a platform developed by Louis Yang, Louis Lefevbre, Thomas Lamiable, and Johan Bognon, similar to Yoka. It aims to provide users with a comprehensive solution for tracking their dietary intake, accessing nutritional information, and discovering new food products.
44-
45-
### Used API
46-
To retrieve information about food products, we utilize the OpenFoodTracks API. This API grants us access to a vast database containing detailed information about food products, including their nutritional composition, ingredients, labels, and nutritional values.
47-
48-
https://fr.openfoodfacts.org
49-
50-
### Key Features
51-
- Search for food products by name, brand, or category.
52-
- Display detailed nutritional information for each product.
53-
- Track daily and historical dietary intake.
54-
- Receive suggestions for similar or alternative products.
55-
- Create shopping lists and track food purchases.
56-
- Technologies Used
57-
58-
- The Yaku project is primarily developed using modern web technologies such as React Native.
59-
60-
For more information about the project and its development, feel free to check out our GitHub repository and contribute if you're interested!
61-

0 commit comments

Comments
 (0)