Giter VIP home page Giter VIP logo

aren's Introduction

AREN (ARgumentation Et Numérique)

The AREN project (in French, ARgumentation Et Numérique ; argumentation and digital) aims to develop a digital platform for online debates that promotes the development of people' argumentative skills and their critical thinking, through a citizenship education perspective. This platform allows the simultaneous participation of a large number of people in a debate, offers time to build arguments and allows to keep track of exchanges, support for reflective work.

The project has two research components :

  • A didactic component consists of experimenting with the platform in order to assess its impact and suggest changes.
  • An artificial intelligence (AI) component focuses on the automatic processing of natural language and aims to develop and evaluate an AI service for thematic classification of student interventions, facilitating their analysis and the preparation of the reflective synthesis.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • Java Web server (Test and work on Apache-Tomcat 7.0.80+)
  • Maven
  • PostgreSQL

Installation

Database

Install and configure PostgreSQL specificaly to your OS, check the documentation, to ensure having a secure and remote accessible database.

Create the user that will manage your database. Repalce [db_user] and [db_password] by your own choices. CREATE USER [db_user] WITH PASSWORD '[db_password]'; Create the database, Replace [db_name] by your own choice. CREATE DATABASE [db_name] OWNER [db_user];

Configuration

Download and extract the sources in the repository of your choice.

Build

Go to the source folder and run mvn clean install. A target folder is then created with the aren.war file inside.

Deployement

Deploy the aren.war on the Java WebSever of your choice [Tomcat 7 tested and functional].

First launch

On the first launch, the application will ask you for DB creentials. This infomation will be stored in ${catalina.base}/conf/aren.properties, so make sure this file is writable by the Tomcat process.

Update from 3.9.x to 3.11.x

  • Dump your SQL data with pg_dump -h [db_server] -p [db_port] -a -U [db_user] [db_name] > dump.sql
  • Drop the DB with dropdb -U [db_user] [db_name]
  • Recreate the database with createdb -U [db_user] [db_name]
  • Start the application like for a first deployment.
  • Open the application in your browser and set the DB credentials as asked. Do not pursue much further on the browser !
    • The database schema is now created.
  • Execute the following SQL code ALTER TABLE documents ADD COLUMN tags text; ALTER TABLE documents ADD COLUMN proposed_tags text;
  • Import your old datas with psql -h [db_server] -p [db_port] -a -U [db_user] -f dump.sql [db_name] and correct the errors.
    • The notifications were not being remove, so some foreign key error may arrive, they can be ignored.
  • Execute the following SQL code ALTER TABLE documents DROP COLUMN tags; ALTER TABLE documents DROP COLUMN proposed_tags;
  • Update the database serials with those lines :
ALTER TABLE debates ADD reformulation_mandatory BOOLEAN;
UPDATE debates SET reformulation_mandatory = TRUE;
SELECT setval('comments_id_seq', (SELECT MAX(id) FROM comments));
SELECT setval('configurations_id_seq', (SELECT MAX(id) FROM configurations));
SELECT setval('debates_id_seq', (SELECT MAX(id) FROM debates));
SELECT setval('documents_id_seq', (SELECT MAX(id) FROM documents));
SELECT setval('institutions_id_seq', (SELECT MAX(id) FROM institutions));
SELECT setval('notifications_id_seq', (SELECT MAX(id) FROM notifications));
SELECT setval('teams_id_seq', (SELECT MAX(id)  FROM teams));
SELECT setval('users_id_seq', (SELECT MAX(id)  FROM users));
  • Finish the configuration in your browser.

Documentation

The web interface is shiped with an useful help button. Use it if you have any issues. The REST API documentation can be found here. You can access the openapi desc directly through the application with the url /ws/openapi.[json|yaml]

Running the tests

@TODO

Built With

Contributing

@TODO

Versioning

We use SemVer for versioning.

Authors

See also the list of CONTRIBUTORS who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgment

Official website

aren's People

Contributors

aren-consortium avatar florentdescroix avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.