rooty/fab-manager
1
0
Fork 0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2024-12-01 12:24:28 +01:00
Code Issues Releases Activity

improved documentation

Browse Source
This commit is contained in:
Sylvain 2021-06-08 09:44:34 +02:00
parent 684e6f779b
commit 4e06ba5a4d
5 changed files with 40 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -8,7 +8,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 and production documentations
- Improved documentations
- Improved the style of the titles of the subscription page
- Check the status of the assets' compilation during the upgrade
- Footprints are now generated in a more reproductible way

36
README.md
View File

@ -7,27 +7,14 @@ Fab-manager is the Fab Lab management solution. It provides a comprehensive, web
[![Docker Build Status](https://img.shields.io/docker/cloud/build/sleede/fab-manager.svg)](https://hub.docker.com/r/sleede/fab-manager/builds)
[![Crowdin](https://badges.crowdin.net/fab-manager/localized.svg)](https://crowdin.com/project/fab-manager)
Please visit [fab-manager.com](https://www.fab-manager.com/) for more information about this software and its features.
##### Table of Contents
1. [Software stack](#software-stack)
2. [Contributing](#contributing)
3. [Documentation](#documentation)
4. [Open Projects](#open-projects)
5. [Plugins](#plugins)
6. [Single Sign-On](#sso)
7. [Related Documentation](#related-documentation)
<a name="software-stack"></a>
## Software stack
Fab-manager is a Ruby on Rails / AngularJS web application that runs on the following software:
- Ubuntu LTS 14.04+ / Debian 8+
- Ruby 2.6
- Redis 6
- Sidekiq 6
- Elasticsearch 5.6
- PostgreSQL 9.6
1. [Contributing](#contributing)
2. [Documentation](#documentation)
3. [Open Projects](#open-projects)
4. [Plugins](#plugins)
5. [Single Sign-On](#sso)
<a name="contributing"></a>
## Contributing
@ -81,12 +68,3 @@ Fab-manager can be connected to a [Single Sign-On](https://en.wikipedia.org/wiki
Currently, OAuth 2 is the only supported protocol for SSO authentication.
For an example of how to use configure an SSO in Fab-manager, please read [sso_with_github.md](doc/sso_with_github.md).
<a name="related-documentation"></a>
## Related Documentation
- [Ruby 2.6.5](http://ruby-doc.org/core-2.6.5/)
- [Ruby on Rails](http://api.rubyonrails.org)
- [AngularJS](https://docs.angularjs.org/api)
- [Angular-Bootstrap](http://angular-ui.github.io/bootstrap/)
- [ElasticSearch 5.6](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/index.html)

16
doc/architecture.md
View File

@ -1,6 +1,20 @@
# Architecture
## Root
Fab-manager was built on top of Ruby on Rails. Ruby on rails provides a REST API used by a single-page web application.
Historically, the front-end was using Angular.js but as this framework won't be supported anymore in a near future, we're progressively moving to React.
## Software dependencies
- Ruby 2.6
- Rails 5.2
- Sidekiq 6
- Docker
## Databases
- Redis 6
- Elasticsearch 5.6
- PostgreSQL 9.6
## Source-code architecture
`fab-manager/`<br>
`╠═ .docker/` In development, data of the databases are stored in this untracked folder;<br>

15
doc/development_readme.md
View File

@ -9,7 +9,8 @@ This document will guide you through all the steps needed to set up a developmen
3. [ElasticSearch](#elasticsearch)<br/>
3.1. [Rebuild statistics](#rebuild-stats)<br/>
3.2. [Backup and Restore](#backup-and-restore-elasticsearch)
3.3. [Debugging](debugging-elasticsearch)
3.3. [Debugging](#debugging-elasticsearch)
4. [Related documentation](#related-documentation)
This procedure is not easy to follow so if you don't need to write some code for Fab-manager, please prefer the [production installation method](doc/production_readme.md).
@ -92,7 +93,7 @@ This procedure is not easy to follow so if you don't need to write some code for
node --version | grep -q `cat .nvmrc` && echo "ok"
# Must print ok
```
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
@ -199,3 +200,13 @@ Restore it with: `elasticdump --input=fablab_stats.json --output=http://localhos
### Debugging
In development, visit http://fabmanager-kibana:5601 to use Kibana, the web UI for ElasticSearch
<a name="related-documentation"></a>
## Related Documentation
- [Ruby 2.6.5](http://ruby-doc.org/core-2.6.5/)
- [Ruby on Rails](http://api.rubyonrails.org)
- [AngularJS](https://docs.angularjs.org/api)
- [Angular-Bootstrap](http://angular-ui.github.io/bootstrap/)
- [ElasticSearch 5.6](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/index.html)

5
doc/production_readme.md
View File

@ -41,7 +41,10 @@ Choose one, depending on your budget, on the server's location, on the uptime gu
You will need at least 2GB of addressable memory (RAM + swap) to install and use Fab-manager.
We recommend 4 GB RAM for larger communities.
Choose a [supported operating system](../README.md#software-stack) and install docker on it:
Supported operating systems are Ubuntu LTS 16.04+ and Debian 8+ with an x86 64-bits architecture.
This might work on other linux systems, and CPU architectures but this is untested for now, and we do not recommend for production purposes.
Choose one and install docker on it:
- Install [Docker on Debian](https://docs.docker.com/engine/installation/linux/docker-ce/debian/)
- Install [Docker on Ubuntu](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/)