Raised-Hands is a platform that increases classroom engagement, and shortens the feedback loop for teachers and students knowing how the class is progressing.
TBD
This project has 2 main components: a web server, and a web client. Below, steps are given for setting them up on your own machine.
- Java 8 (JDK + JRE)
- Node >= 12
- Docker
- Using this method also starts the server in debug mode, allowing you to attach a remote debugger (using intelliJ for instance) on port
5005
- First create a new build for the server. From a terminal
cd
into theraised-hands-server
directory, and use Gradle to create a build:$ cd /path/to/raised-hands/raised-hands-server $ ./gradlew build
- Create a copy of
.env.template
named.env
in the top-levelraised-hands
project directory, and fill in the appropriate values for the environment variables:$ cd /path/to/raised-hands $ cp .env.template .env $ vim .env # Database POSTGRES_USER=<provide your value> POSTGRES_PASSWORD=<provide your value> ... # other env variables
docker-compose
can be used to stand up both the server and web-client by executing the following from the top-levelraised-hands
project directory:$ cd /path/to/raised-hands $ docker-compose up --build -t
- Communicate with the server from
localhost:8080
- Attach a remote debugger to the server from
localhost:5005
- Access the web-client from
localhost:3000
Using Docker
- Create a build: from CLI in the
raised-hands-server
directory, execute:$ ./gradlew build
- Containerize the build:
$ docker build --build-arg JAR_FILE=build/libs/*.jar -t raised-hands/raised-hands-server .
- Run the containerized server:
$ docker run -p 8080:8080 -t raised-hands/raised-hands-server
- You can now communicate with the server at
localhost:8080
Using Gradle
-
Create a build: from CLI in the
raised-hands-server
directory, execute:$ ./gradlew build
-
After the build is completed, from the same folder, execute:
$ java -jar build/libs/raised-hands-server-{project version}.jar
replace {project version} with the value found in
build.gradle
-
You can now communicate with the server at
localhost:8080
- Install dependencies for web-client: from
raised-hands-web-client
directory, execute:$ npm i
- Run the client:
$ npm start
- You can now view the web-client at
localhost:3000
From raised-hands-server
directory, execute:
$ ./gradlew test
From raised-hands-web-client
directory, execute:
$ npm test
TODO
TODO
- Jenisha Adhikari
- Taslim Dosunmu
- Faizon Williams
- Chengyong Zhao