syntaxEra

syntaxEra is an engineering class project, the application allow you to create or read courses on various subjects.

Authors: Charlène Gros and Loïc Pottier

Database initialization

Launch the db, copy the database schema and seed the database with it.

On windows

docker-compose up -d
docker cp schema.sql syntaxera_postgres:/schema.sql
docker exec -it syntaxera_postgres psql -U root -d syntaxera_db -f /schema.sql

To turn off the db, stop the container with:

docker-compose down

On linux

The mountsql.sh do it for you ! run sh mountsql.sh to launch and seed the db, and sh mountsql.sh <something> to turn it off !

Running the app

You can now execute the SyntaxeraWebApplication.java in syntaxera-web module to run the app or the SyntaxeraApiApplication.java in syntaxera-api to only start the api endpoints.

This will launch the app on port 8080, giving access to these pages:

• http://localhost:8080/courses
• http://localhost:8080/courses/new
• http://localhost:8080/course/{courseId}

There is also the Swagger UI available at:

• http://localhost:8080/swagger-ui/index.html

The project has 3 maven modules and must be compiles with Java 21.
The database is a PostgreSQL database containing 5 tables.