Skip to content

Commit

Permalink
docs: frontend app docs and instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Jakub Drbohlav committed Mar 3, 2025
1 parent 2bbe978 commit 30b11c6
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 7 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
# project-biot-team-001

Semestral work in subject **Internet of Things**.

## Frontend Application

The frontend application is a **React app**. It is deployed and available at:\
🔗 **[https://iot-team-001.web.app/](https://iot-team-001.web.app/)**

All frontend development, including source code and build configuration, is located in the `frontend/` directory of this repository.
53 changes: 46 additions & 7 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,51 @@
# React + Vite
# Frontend Application

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
This is a **Vite + React** application.

Currently, two official plugins are available:
## Installation

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
To set up the project locally, follow these steps:

## Expanding the ESLint configuration
1. **Clone the repository:**
```sh
git clone https://github.com/UnicornUniversity/project-biot-team-001.git
```
2. **Navigate to the frontend directory:**
```sh
cd project-biot-team-001/frontend
```
3. **Install dependencies:**
```sh
npm install
```

If you are developing a production application, we recommend using TypeScript and enable type-aware lint rules. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
## Development

To start development:

1. **Create a new branch**
```sh
git checkout -b my-feature-branch
```
2. **Run the development server:**
```sh
npm run dev
```
3. The app will be available at [http://localhost:5173/](http://localhost:5173/). You can now develop and make changes.
4. **When you're done:**
- Commit and push your changes:
```sh
git add .
git commit -m "Describe your changes"
git push origin my-feature-branch
```
- Open a **Pull Request (PR)** on GitHub

## Deployment

Once your pull request is **reviewed by codeowners** and **all checks (build and code format) pass**, you can **merge it into** `master`.

The application will be automatically deployed to:\
🔗 [https://iot-team-001.web.app/](https://iot-team-001.web.app/)

Deployment usually completes **within a few minutes**.

0 comments on commit 30b11c6

Please sign in to comment.