README.md

crnk-spring-boot

Spring boot application to provide json:api compatible API using CRNK framework.

What is JSON:API ?

JSON:API is a specification for how a client should request the resources to be fetched or modified, and how a server should respond to those requests

Read the full specification of JSON:API at - https://jsonapi.org

What is crnk ?

CRNK is a framework which helps in developing resource oriented REST API's. And is also one of implementations of JSON:API specification.

Read more about crnk at - https://www.crnk.io

Software requriements

1. Postgres DB
2. Java 1.8 +
3. Lombok plugin (for IDE) - annotation processing needs to be enabled in IDE

DB setup

1. postgres was used as DBMS
2. Run the command CREATE DATABASE "crnk-university" from postgres console to create the database. Pgadmin can also be used.
3. To setup the DB schema, execute create_tables.sql file from the path src/main/resources/db

Steps to execute

1. If you are running project using command line, replace the environment variables in application.yml file with appropriate values. Incase of IDE, environment variables can be configiured in run configuration.
2. mvn clean install to download the dependencies, compile and package the jar
3. Run the command java -jar target/crnk-spring-boot-0.0.1-SNAPSHOT.jar to run the packaged jar
4. If you are using IDE, you can directly run the main application class CrnkSpringBootApplication.java