boxes-fe/README.md

47 lines
1.4 KiB
Markdown
Raw Normal View History

2024-10-09 05:01:13 +00:00
# Boxes App (Frontend)
2024-10-09 05:01:13 +00:00
This is the frontend application for the Boxes App, built with React. It allows users to manage boxes and their contents.
2024-10-09 05:01:13 +00:00
## Features
2024-10-09 05:01:13 +00:00
- **User Authentication:** Users can log in to access their boxes and items.
- **Box Management:**
- Create new boxes.
- View a list of existing boxes.
- Delete boxes.
- **Item Management:**
- View items within a box.
- Add new items to a box.
- Edit existing item details.
- Delete items from a box.
2024-10-09 05:01:13 +00:00
## Technologies Used
2024-10-09 05:01:13 +00:00
- **React:** JavaScript library for building user interfaces.
- **Material-UI:** React component library for providing pre-built UI elements.
- **Axios:** Promise-based HTTP client for making API requests.
- **React Router:** Library for handling routing and navigation in a React application.
2024-10-09 05:01:13 +00:00
## Installation
2024-10-09 05:01:13 +00:00
1. **Clone the repository:**
```bash
2024-10-09 05:01:50 +00:00
git clone git@gitea.r8z.us:stwhite/boxes-fe.git
2. create the docker builder
```bash
docker build -f Dockerfile.build -t boxes-fe-builder .
```
3. build the application using the docker builder
```bash
docker run box-builder:latest
docker container create --name tmp-con boxes-fe-builder -- sleep 1200
docker cp tmp-con:/app/build ./boxes-fe/build
docker rm tmp-con
```
4. copy the appliction to the boxes-api /build directory
```bash
cp -r ./boxes-fe/build/* ../boxes-api/build/
```