Skip to content
Open
Changes from all commits
Commits
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
77 changes: 18 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,29 @@
# Getting Started with Create React App
# Arrayan

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Arrayan is a Food Supply Chain application built on the blockchain fabric of Resilient DB that tracks the products, by-products, and process history through the Food Supply Chain.

## Available Scripts
- Web Application: Built using React JS, [Create React App](https://github.com/facebook/create-react-app), [React Official Website](https://react.dev/)
- Database: Powered by ResilientDB, [ResilientDB](https://resilientdb.com/)
- Theme: BLK Design System React, [BLK Design System Pro React](https://demos.creative-tim.com/blk-design-system-pro-react/?_ga=2.58939236.839164262.1702005007-948628969.1702005007#/presentation)

In the project directory, you can run:
## Modifications

### `npm start`
We have modified the existing GraphQL APIs to suit the needs of the food supply chain.

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

The page will reload when you make changes.\
You may also see any lint errors in the console.
### Home Page

### `npm test`
- Provides a general overview of the solution offered through the website.
- Real-time Display enables real-time visualization of the current inventory status.

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### Inventory

### `npm run build`
- **Seamless Upload Process**: Allows consumers to easily upload Excel files containing inventory data. Multiple Excel files can be uploaded and loaded consecutively.
- **Transparent Inventory View**: Shows a clear and accessible display of updated inventory information visible to consumers.

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

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

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

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](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](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](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](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](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](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
- **Search Option**: Enables users to search and track any final product through the food supply chain.
- **Visualizes Supply Chain**: Provides a comprehensive supply chain mapping of each product's entire supply chain and process details.
- **By-products Tracking**: By-products in the process can also be tracked and claimed by consumers, ensuring a circular economy is maintained.