Skip to content
Snippets Groups Projects
Commit 260db77d authored by Hugo NOUTS's avatar Hugo NOUTS
Browse files

fixes

parent b81b1048
No related branches found
No related tags found
No related merge requests found
Pipeline #8361 passed
......@@ -7,6 +7,11 @@
* `mkdocs build` - Build the documentation site.
* `mkdocs help` - Print this help message.
## Mkdocs packages
py -m pip install mkdocs-material
py -m pip install plantuml-markdown
## Setting files hierarchy
inside mkdocs.yml use the key nav: to configure the md files hierarchy
......@@ -42,15 +47,9 @@
- Grdf Adict: proxy/use_cases/grdfadict.md
## Project layout
mkdocs.yml # The main file and configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
## Mkdocs packages
py -m pip install mkdocs-material
py -m pip install plantuml-markdown
\ No newline at end of file
......@@ -85,7 +85,11 @@ Now you should be at least in version ^1.22 and ready to go on.
First open a new session and connect to the distant host **192.168.62.31**. Don't forget to add the path to the private key in the advanced SSH settings.
## Deploy your branch/app
## Deploy Ecolyo
### Deploy on Alpha
#### Windows
First open your Ubuntu terminal, and clone the project in the repertory of your choice. Once you've selected the branch of you want to deploy, write the following command :
```
......@@ -105,3 +109,7 @@ yarn deploy
```
To deploy on the llle-build environment, you'll have to drag and drop your build folder directly in llle-build using MobaXterm.
#### Linux
From your current branch, run ```yarn build``` then ```sudo yarn deploy_dev``` to instantly deploy your working branch on the latest tagged Ecolyo container registry.
......@@ -58,7 +58,7 @@ If this file is not empty, you can simply add the follwing lines to it:
To install required node module, open a terminal on the root folder of the projet and type the following command:
```
yarn
yarn install
```
### Start Ecolyo application
......@@ -69,22 +69,23 @@ To start ecolyo application just launch the command:
yarn start
```
If application start successfully you should obtain following message:
If the application starts successfully you should obtain the following message:
> App successfully updated!<br>
> Dev assets: http://localhost:8888
> App successfully compiled!
> Dev assets:http://localhost:8888
!!! info "Fix webpack error on cozy script"
During launching you may have the following error: ** TO BE COMPLETED **
Once the application is started, run the easy-cozy stack with docker.
!!! info "Fix webpack error on cozy script"
**Deprecated** Updated cozy-script lib
To fix it launch the following command in node_modules/cozy-script folder:
```
yarn add webpack
```
### Run the dev stack
### Run easy-cozy dev stack
The dev stack will contain the cozy-stack with some default applications and konnectors and allow you to run this stack localy.
The dev stack will contain the cozy-stack with some default applications and konnectors and allow you to run this stack locally.
First login to the forge registry:
......@@ -116,10 +117,10 @@ Local database can also be consulted at the following url: [Cozy local DB](http:
#### On Linux
From the project build folder, launch following command:
From the project folder, launch following command:
```
docker run --rm -it -p 8080:8080 -p 5984:5984 -p 8025:8025 -v $(pwd):/data/cozy-app -v ~/cozy/data/db:/usr/local/couchdb/data -v ~/cozy/data/storage:/data/cozy-storage --name=cozydev cozy/cozy-app-dev
yarn linuxstack
```
Wait until the success message:
......
......@@ -24,19 +24,28 @@ Optional extensions:
- Auto Rename Tag
- indent-rainbow
- TabOut
- Liveshare (pair programming extension)
### User settings
User settings for Ecolyo are describ in this section: **LINK TO SECTION TO ADD**
User settings for Ecolyo are described in this section: **LINK TO SECTION TO ADD**
## Git
The project is using GitLab, you will need to install Git to checkout the projet.
Installation for Git can be found here: [Installation of Git](https://git-scm.com/).
## Node
!!! warning "Version 12"
For now please install node v12, any later version will cause side effects on sass modules!
Download [node-v12](https://nodejs.org/dist/latest-v12.x/node-v12.19.0-x64.msi)
Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
## Yarn
Yarn is used as package manager for this projet. Feel free to use the one you prefere but we advice to install yarn as all the documentation is describe with this package manager.
Yarn is used as package manager for this projet. Feel free to use the one you prefere but we advice to install yarn as all the documentation is described with this package manager.
Installation for yarn can be found here: [Installation of Yarn](https://classic.yarnpkg.com/fr/docs/install/).
## Docker
......
LLLE - Ecolyo is a multi-fluid application solution towards users of the grand lyon metropolis to monitor and optimize their energy consumption.
!!! info ""
If you are a new developper tasked to work on this project, check the [setup your environment](./getting_started/setup_your_environment.md) and [setup your environment](./getting_started/launch_local_application.md) to start the application.
If you are a new developper tasked to work on this project, check the [setup your environment](./getting_started/setup_your_environment.md) and [launch the application on local](./getting_started/launch_local_application.md) to start the application.
## Repository
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment