phd-portal-server
🎓 Designing and implementing a Doctoral Admission and Training System 🎓
🚀 About
The project should develop an engineering solution for digitizing an information system for doctoral students and candidates in order to be used by higher education institutions, which would integrate into the systematic process for the management and management of the so -called “digital university”.
🎉 Getting started
✅ Prerequisites
In order to run the app, make sure you have installed the following dependencies
| Program | URL |
|---|---|
| Java | Java |
| Quarkus | Quarkus |
| AWS Vault [Optional] | AWS Vault |
| PostgreSQL | PostgreSQL |
| ElasticSearch | ElasticSearch |
If you are using Nix or NixOS you can install them in flake.nix via devenv
🌱 Setup
- Make sure to have elastic search instance up and running
- you can also execute
make servicesto run it via devenv
- you can also execute
- Add your secrets in
.envfile.- credentials from the postgresql database
- credentials from smtp to send emails
- credentials (access key and secret key) on AWS for storing media assets
🏗️ Build
quarkus build
# Or
make build
# Bulid a docker image
docker build -t IliyanKostov9/phd-server:1.0.0 .
# Or
make docker-build
🏃 Run
quarkus dev -Dquarkus.profile=dev
# Or
make run
🧑💻 Commands
| Command | Description |
|---|---|
| make help | Show available commands with their description |
| make help-server | Show available commands for quarkus with their description |
| make sys-update- | Build your system configuration |
| make all | Run all commands at once |
| make run | Run the server |
| make services | Run elastic search via devenv |
| make stop | Stop elastic search via devenv |
| make test | Run tests |
| make build | Build the server |
| make clean | Uninstall the deps and bulid again |
| make install | Install the deps |
| make elastic-attach | Attach to the Elastic search TUI via devenv |
📚 Docs
📃 License
This product is licensed under GNU General Public License