Jobcrawler Backend

This repository is no longer maintained. Please head to Jobcrawler-backend for furthur development.

Backend for the job crawler to find IT vacancies

Endpoints

All endpoints and their functionality is described in the endpoint document

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

What things you need to install the application and how to install them

Maven

Download and install Maven. Check if Maven is working:

mvn --version

Docker

Install docker as described here. If you're installing on Ubuntu or a different linux system, check out these pages for installation. Check if Docker is working:

docker --version

Installing

Install these things to be able to run the application locally:

Database

This application uses PostgreSQL as database. To run the database locally, perform the following commands:

If you haven't created the container before, create and start the container with the "docker run" command. Replace the "*password*" part with your own password. This must be the same password as the "DB_PASS" variable declared here.

docker run --name jobcrawler-postgres -e POSTGRES_PASSWORD=*password* -d -p 5432:5432 postgres

Otherwise, if you did create the container before, run this:

docker start jobcrawler-postgres

Now navigate into the postgres docker container and open bash:

docker exec -it jobcrawler-postgres bash

Log into the postgres server with the user "postgres"

psql -U postgres

Now check if the jobcrawler database is present:

\list

If the jobcrawler database is not there, create the jobcrawler database:

create database jobcrawler;

Running the tests

-- Explain how to run the automated tests for this system --

Deployment

-- Add additional notes about how to deploy this on a live system --

Built With

• Maven - Dependency Management
• Spring-Boot - API framework
• PostgreSQL - Database

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Adriaan Bakker - adriaanbakker-java
• Gijs Overvliet - ghyze
• Mostafa Abd Elrehim - mostafa-221
• Timo Koen - tkoen93
• Jelmer Pijnappel - ChocolatePinecone

Acknowledgments

• Hat tip to anyone whose code was used