Skip to content

Commit

Permalink
Merge pull request #138 from arnobl/readme-install
Browse files Browse the repository at this point in the history 
doc(readme): updating the readme with install infos
  • Loading branch information
@barais
barais authored May 7, 2024
2 parents 82bf241 + 6b95a4e commit 57f87b9
Showing 1 changed file with 53 additions and 79 deletions.
132 changes: 53 additions & 79 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# correctExamBack
# CorrectExam back-end

Deliver and Grade Your Assessments Anywhere
The back-end of the app CorrectExam.

## CorrectExam

**Deliver and Grade Your Assessments Anywhere**

This application helps you seamlessly administer and grade all of your in-class assessments (long exam or short). Save time grading and get a clear picture of how your students are doing. Provide a clear feedback to your students.

# Feature
### Feature

Main feature are:

Expand All @@ -15,29 +19,65 @@ Main feature are:
- use your tablet and your pen to annotate student sheet
- provide clear feedback to your students

# Technical stack
### Technical stack


This application was generated using JHipster 6.10.5 and JHipster Quarkus 1.1.1 (manually upgraded to quarkus 2.9.2.Final), you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v6.10.5](https://www.jhipster.tech/documentation-archive/v6.10.5).


## Build and deploy
### Build and deploy

Documenttion to deploy your own instance is available [here](https://correctexam.readthedocs.io/en/latest/Install.html)
Documentation to deploy your own instance is available [here](https://correctexam.readthedocs.io/en/latest/Install.html)



## Development

To start your application in the dev profile, run:
### Install

The back-end requires Minio to store the PDF files.
An easy way to install and launch Minio on your computer is to use an official Docker image:

```
podman run -p 9000:9000 -d -p 9090:9090 -e "MINIO_ROOT_USER=admin" -e "MINIO_ROOT_PASSWORD=minioadmin" -v /media/data/miniofiles:/data:Z quay.io/minio/minio server /data --console-address ":9090"
```

The back-end also requires a database.
On Linux you can install MariaDB.
On Fedora, you can run:

```
sudo dnf install mariadb-server
sudo systemctl enable mariadb
sudo systemctl start mariadb
sudo mysql_secure_installation
sudo mysql -u root
CREATE DATABASE gradeScopeIstic;
```

The first run of the back-end must initial and populate the DB with fake data. To do so, run:
```
./mvnw quarkus:dev -Dquarkus.liquibase.migrate-at-start=true
```

It creates two users `user:user` and `admin:admin`.
After that you can launch the back-end classically `./mvnw`


### Run in development mode

To start your application in the dev profile, run:

./mvnw
```
./mvnw
```

For further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].

## Building for production
### Building for production

### Packaging as thin jar
#### Packaging as thin jar

To build the final jar and optimize the correctExam application for production, run:

Expand All @@ -51,7 +91,7 @@ To ensure everything worked, run:

Refer to [Using JHipster in production][] for more details.

### Packaging as native executable
#### Packaging as native executable

_Targeting your Operation System_
In order to build a native image locally, your need to have [GraalVM](https://www.graalvm.org/) installed and `GRAALVM_HOME` defined.
Expand All @@ -72,15 +112,15 @@ If you plan to run your application in a container, run:

It will use a Docker container with GraalVM installed and produce an 64 bit Linux executable.

## Testing
### Testing

To launch your application's tests, run:

./mvnw verify

For more information, refer to the [Running tests page][].

## Using Docker to simplify development (optional)
### Using Docker to simplify development (optional)

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the [src/main/docker](src/main/docker) folder to launch required third party services.

Expand All @@ -100,69 +140,3 @@ To stop it and remove the container, run:
[running tests page]: https://www.jhipster.tech/documentation-archive/v6.10.5/running-tests/
[code quality page]: https://www.jhipster.tech/documentation-archive/v6.10.5/code-quality/
[setting up continuous integration]: https://www.jhipster.tech/documentation-archive/v6.10.5/setting-up-ci/



update question set point = point * 4;

update `student_response` set note = note * 4;
ALTER TABLE `question` ADD `libelle` VARCHAR(255) NULL DEFAULT NULL AFTER `valid_expression`;
ALTER TABLE `gradeScopeIstic`.`final_result` ADD UNIQUE `UniqueStudentIdAndExamId` (`student_id`, `exam_id`);


create table answer_2_hybrid_graded_comment (id bigint not null auto_increment, step_value integer, hybridcomments_id bigint, student_response_id bigint, primary key (id)) engine=InnoDB;
create table hybrid_graded_comment (id bigint not null auto_increment, description longtext, grade integer, relative bit, step integer, text varchar(255), question_id bigint, primary key (id)) engine=InnoDB;


alter table final_result add column frozen bit;
alter table question add column defaultpoint integer;
alter table answer_2_hybrid_graded_comment add constraint FK9ijm3itpjwpgf534m94df8dt6 foreign key (hybridcomments_id) references hybrid_graded_comment (id);
alter table answer_2_hybrid_graded_comment add constraint FKqxflsw40s622dtyt99himou2k foreign key (student_response_id) references student_response (id);
alter table hybrid_graded_comment add constraint FKrrl2y7dngtnqlklwt0scsy8jq foreign key (question_id) references question (id);

ALTER TABLE `gradeScopeIstic`.`answer_2_hybrid_graded_comment` ADD UNIQUE `UniqueHybridcommentsIdAndStudentResponseId` (`student_response_id`, `hybridcomments_id`);

ALTER TABLE `student_response` ADD UNIQUE(`question_id`, `sheet_id`);


alter table student_response add column lastmodified datetime(6);
alter table student_response add column correctedby_id bigint;
alter table student_response add constraint FKinrpshecm7c6aiqo6000ju87c foreign key (correctedby_id) references jhi_user (id);

alter table question add column randomhorizontalcorrection bit default 0;



[x] unique constraint for answer_2_hybrid_graded_comment
[x] delete correctly when removing exam or course
[x] Import Export with HybridComment
[x] Test import and export
[x] check delete
[x] Export PDF with HybridComment

[x] update question or hybridComment => recompute score4 linked StudentResponse
[x] test update question or hybridComment => recompute score4 linked StudentResponse
[x] update maximal step from 5 to 12.
[x] Allow direct grading when clicking to star
[x] Update view copie4student
[x] update show all with this hybridComment
[x] update apply to all the same grade



SELECT resp.id FROM `student_response` as resp WHERE EXISTS( SELECT * FROM `student_response` as resp2 WHERE resp.id <> resp2.id and resp.question_id = resp2.question_id and resp.sheet_id = resp2.sheet_id);

select * from student_response_textcomments as st3 where st3.student_response_id IN(
SELECT resp.id FROM `student_response` as resp WHERE EXISTS( SELECT * FROM `student_response` as resp2 WHERE resp.id <> resp2.id and resp.question_id = resp2.question_id and resp.sheet_id = resp2.sheet_id));



DELETE from answer_2_hybrid_graded_comment as an where an.student_response_id IN(
SELECT resp.id FROM `student_response` as resp WHERE EXISTS( SELECT * FROM `student_response` as resp2 WHERE resp.id <> resp2.id and resp.question_id = resp2.question_id and resp.sheet_id = resp2.sheet_id));

select an.* from answer_2_hybrid_graded_comment as an where an.student_response_id IN(SELECT resp.id FROM `student_response` as resp WHERE EXISTS( SELECT * FROM `student_response` as resp2 WHERE resp.id <> resp2.id and resp.question_id = resp2.question_id and resp.sheet_id = resp2.sheet_id));

delete an.* from answer_2_hybrid_graded_comment as an where an.student_response_id IN(
SELECT resp.id FROM `student_response` as resp WHERE EXISTS( SELECT * FROM `student_response` as resp2 WHERE resp.id <> resp2.id and resp.question_id = resp2.question_id and resp.sheet_id = resp2.sheet_id));

DELETE FROM `student_response` WHERE id in (53044,53045,53046,53047,53050,53051,53052,53053,53054,53055,53056,53057,53058,53059,53061,53062,53063,53064,53065,53066,53067,53068,53106,53107,53108,53109,53110,53111,53112,53113,53114,53115,53117,53118,53119,53120,53121,53122,53124,53125,53126,53127,53128,53129,53130,53131,53133,53134,53135,53136,53184,53185,53240,53241,53242,53243,53244,53245,53248,53249,53250,53251);

0 comments on commit 57f87b9

Please sign in to comment.