rooty/fab-manager
1
0
Fork 0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2025-01-17 06:52:27 +01:00
Code Issues Releases Activity

Improved the development documentation

Browse Source
This commit is contained in:
Sylvain 2021-04-27 09:03:49 +02:00
parent 1bf091081b
commit b2e8d993e7
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -4,6 +4,7 @@
- Updated React and its dependencies to 17.0.3 and matching
- Updated the dependencies of: webpack, lodash, eslint, webpack-dev-server, react2angular, auto-ngtemplate-loader, angular-bootstrap-switch, react-refresh-webpack-plugin and eslint-plugin-react
- Improved error handling in upgrade script
- Improved the development documentation
- Fix a bug: unable to set date formats during installation
- Fix a bug: unable to cancel the upgrade before it begins
- `SUPERADMIN_EMAIL` renamed to `ADMINSYS_EMAIL`

21
doc/development_readme.md
View File

@ -28,7 +28,7 @@ This procedure is not easy to follow so if you don't need to write some code for
4. Install docker.
Your system may provide a pre-packaged version of docker in its repositories, but this version may be outdated.
Please refer to [ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/), [debian](https://docs.docker.com/install/linux/docker-ce/debian/) or [MacOS](https://docs.docker.com/docker-for-mac/install/) documentation to setup a recent version of docker.
Please refer to the [official docker documentation](https://docs.docker.com/engine/install/) to set up a recent version of docker.
5. Add your current user to the docker group, to allow using docker without `sudo`.
```bash
@ -80,6 +80,8 @@ This procedure is not easy to follow so if you don't need to write some code for
```bash
brew install imagemagick
```
- For other systems, please refer to your system specific documentation to install the appropriate packages: ImageMagick and the PostgreSQL development library
9. Init the RVM and NVM instances and check they were correctly configured
@ -92,7 +94,6 @@ This procedure is not easy to follow so if you don't need to write some code for
```
If one of these commands does not print "ok", then try to input `rvm use` or `nvm use`
```
10. Install bundler in the current RVM gemset
@ -132,7 +133,7 @@ This procedure is not easy to follow so if you don't need to write some code for
RAILS_ENV=test rails db:migrate
```
14. Create the pids folder used by Sidekiq. If you want to use a different location, you can configure it in `config/sidekiq.yml`
14. Create the pids folder used by Sidekiq. If you want to use a different location, you can configure it in [config/sidekiq.yml](config/sidekiq.yml)
```bash
mkdir -p tmp/pids
@ -144,9 +145,9 @@ This procedure is not easy to follow so if you don't need to write some code for
foreman s -p 5000
```
16. You should now be able to access your local development Fab-manager instance by accessing `http://localhost:3000` in your web browser.
16. You should now be able to access your local development Fab-manager instance by accessing `http://localhost:5000` in your web browser.
17. You can login as the default administrator using the credentials defined previously.
17. You can log in as the default administrator using the credentials defined previously.
18. Email notifications will be caught by MailCatcher.
To see the emails sent by the platform, open your web browser at `http://fabmanager-mailcatcher:1080` to access the MailCatcher interface.
@ -169,16 +170,16 @@ Some information about PostgreSQL usage in fab-manager is available in the [Post
ElasticSearch is a powerful search engine based on Apache Lucene combined with a NoSQL database used as a cache to index data and quickly process complex requests on it.
In FabManager, it is used for the admin's statistics module.
In FabManager, it is used for the administrator's statistics module.
The organisation if the data in the ElasticSearch database is documented in [elasticsearch.md](elasticsearch.md)
<a name="rebuild-stats"></a>
### Rebuild statistics
Every nights, the statistics for the day that just ended are built automatically at 01:00 (AM) and stored in ElasticSearch.
Every night, the statistics for the day that just ended are built automatically at 01:00 (AM) and stored in ElasticSearch.
See [schedule.yml](config/schedule.yml) to modify this behavior.
If the scheduled task wasn't executed for any reason (eg. you are in a dev environment and your computer was turned off at 1 AM), you can force the statistics data generation in ElasticSearch, running the following command.
If the scheduled task wasn't executed for any reason (e.g. you are in a dev environment, and your computer was turned off at 1 AM), you can force the statistics data generation in ElasticSearch, running the following command.
```bash
# Here for the 50 last days
@ -188,7 +189,7 @@ rails fablab:es:generate_stats[50]
<a name="backup-and-restore-elasticsearch"></a>
### Backup and Restore
To backup and restore the ElasticSearch database, use the [elasticsearch-dump](https://github.com/taskrabbit/elasticsearch-dump) tool.
To back up and restore the ElasticSearch database, use the [elasticsearch-dump](https://github.com/taskrabbit/elasticsearch-dump) tool.
Dump the database with: `elasticdump --input=http://localhost:9200/stats --output=fablab_stats.json`.
Restore it with: `elasticdump --input=fablab_stats.json --output=http://localhost:9200/stats`.
@ -197,4 +198,4 @@ Restore it with: `elasticdump --input=fablab_stats.json --output=http://localhos
<a name="debugging-elasticsearch"></a>
### Debugging
In development, visit http://fabmanager-kibana:5601 to use Kibana, the web UI for ElasticSearch
In development, visit http://fabmanager-kibana:5601 to use Kibana, the web UI for ElasticSearch