Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AtelierSoude/OpenRepairPlatform

OpenRepairPlatform is a web application based on Django designed to organizing collaborative and non-profits repair structures - Still in development
https://github.com/AtelierSoude/OpenRepairPlatform

collaborative community django-project event-management membership-management non-profit-organizations repair-management

Last synced: 5 days ago
JSON representation

OpenRepairPlatform is a web application based on Django designed to organizing collaborative and non-profits repair structures - Still in development

Awesome Lists containing this project

README 

        

# OpenRepairPlatform



Ce projet cherche à faciliter l’accessibilité de la réparation par le plus grand nombre. Par une interface simple et claire, l'application web invite participants et organisations à collaborer autours de l’auto-réparation et de la réparation participative.



OpenRepairPlateform est une application basée sur Django, pensée pour organiser les structures de réparations participatives.

Elle intègre principalement des fonctionnalités de gestion d'organisation, de membres, de comptabilité, la publication d'événements, d'inventaire et de suivi/partage de réparations.



Cette application est développée et notamment utilisée par [l'Atelier Soudé](https://atelier-soude.fr) pour la plateforme [Réparons](https://dev.atelier-soude.fr).



Toute la documentation d'installation et d'utilisation est disposible [ici](https://openrepairplatform.readthedocs.io/en/latest/).



----- ENG -----



This application is still in developpment.

Any contributes are welcome. Please contact us if you want to contribute and we tell you how to.



# Atelier Soudé



OpenRepairPlatform is a Django based application designed to organize collaborative repair structures, features provides organization managment, event publishing, community members managment, repair tracking and sharing.



The plateform is created by Atelier Soudé, an organization which repair everyday's people electric and electronic objects in Lyon, France.



Full installation and user documentation are avalaible [here](https://openrepairplatform.readthedocs.io/en/latest/). (sorry, only in French at this point !)



For basic develop installation, follow those steps:



## Run the application (in Develop mode only)



1.Set django, postgres and nginx/domain variables in `openrepairplatform/.env` 



2.Run the following command:



```

docker-compose up

```

You can then access `http://127.0.0.1:8000/` and log with the admin user `[email protected]` // `adminpass`



3.Create an organization within the `http://127.0.0.1:8000/organizations` path and you can start everythings else (further documentation will come)



### Debug with Visual Studio Code



If you open the main folder with vs code, you will be able to use the configuration present in `.vscode`.



This will allow you to connect to the container in debug mode and to stop at breakpoints in the code, which is quite confortable to inspect the variables and test new code in the required state of the program (typically before a failure).

Before starting, you may have to install the Python extension.



For this, just click on `Debug`, and `Start Debugging`: you will run the `Debug Django app` configuration. 

A small additional bar will appear with useful commands for the debug: go to next breakpoint, stop debugging, etc

More information on debugging with vs code: `https://code.visualstudio.com/Docs/editor/debugging`



Create a breakpoint in the code, for example in a view, and go to the corresponding page from your browser.

The browser will freeze and vs code will stop at the breakpoint.



In the lower part of vs code, in the `DEBUG CONSOLE`, you can test code.



In the debug section, in the left vertical bar, you can see all the breakpoints, all the variables and their content, and the call stack.

You can click on any step of the call stack, and browser the variables, test some code, etc, at this step.



### Coding "live"



The local code is mounted in a Docker volume, so if you change the code locally and refresh your browser, you will immediatly see the changes.



### Run unit tests



First, start the containers with `docker-compose up`

Then, run the tests with `docker exec openrepairplatform_django_1 pytest --disable-pytest-warnings --cov=openrepairplatform --cov-report term-missing`



### Run integration tests



Integration tests are run using a Docker image containing a chrome Selenium installation and a VNC server.

It is possible to debug the tests using a local VNC client that connects to the VNC server in the Docker container, that allows to graphically see what the selenium test is doing on the site.



To install the VNC client on your local computer:



`sudo apt-get install krdc`



To launch it:



`krdc`



Start KRDC, and connect to `localhost:5900`



To see the running chrome sessions:

`http://localhost:4444/wd/hub/static/resource/hub.html`



To launch the tests :



First, start the Docker containers with `docker-compose up`, and then:



`docker exec openrepairplatform_selenium_1 python3 -m pytest /tests/integration_tests.py -v`



If you uncomment the following lines, it will wait for a debugger to connect before running the tests



```

ptvsd.enable_attach()

ptvsd.wait_for_attach()

```