Skip to content

Commit

Permalink
Modify the SETUP.md and the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aitormurgu committed Mar 14, 2024
1 parent 9aaa3d7 commit d744b96
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 28 deletions.
41 changes: 15 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,30 @@
# Website
# Biotz Academy

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Tutorials

### Installation
In this complete tutorial, you will find how to create effective data ingestion flow within the Biotz IoT platform, following the different steps. Starting with account creation, and continuing through several more steps.

```
$ yarn
```
## How-to guides

### Local Development
This collection of guides has been crafted to assist you in navigating the features of IoT development and implementation.

```
$ yarn start
```
## Reference

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Your go-to resource for in-depth information about the IoT platform's funcionalities and components.

### Build

```
$ yarn build
```
## Local Development

This command generates static content into the `build` directory and can be served using any static contents hosting service.
The local development is explained step by step in the <a href="/SETUP.md" target="_self">SETUP.md</a> file.

### Deployment
## Deployment

Using SSH:
The deployment is made by the github/workflows <a href="/.github/workflows/deploy.yml" target="_self">deploy.yml</a>.

## Academy page

Here is the Biotz Academy <a href="/https://academy.biotz.io/" target="_self">page</a>.

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
4 changes: 2 additions & 2 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Make sure you have the following instaled on your system.
### 1. Clone the repository

```bash
git clone https://github.com/your_username/your_project.git
git clone git@github.com:biotz/academy.git
```

### 2. Navigate to the Project Directory


```bash
cd your_project
cd academy
```

### 3. Build and Run the Containers
Expand Down

0 comments on commit d744b96

Please sign in to comment.