Giter Site home page Giter Site logo

cook-book's Introduction

Cook Book

Table of Contents

  1. Introduction
  2. Configuration
  3. Development and Running
  4. Docker
  5. Contributing
  6. License

Introduction

Cook Book is a web backend application. It provides APIs to view, query and manage recipes.

It uses

  • Spring Boot 3 with WebFlux
  • Kotlin with coroutines
  • PostgreSQL for database
  • Flyway to manage DB schemas
  • R2DBC for database access
  • JUnit 5 for testing

Configuration

You should be able to run the application out-of-the-box without any further configuration (as long as database is available, see Docker section). However, if you wish to make your own configuration, you can do so via application.yaml. You can also override config values with following environment variables.

Variable Name Data Type Description Required
DB_HOST String Host address of application database No, defaults to localhost
DB_PORT Integer Port of application database No, defaults to 5432
DB_NAME String Name of application database No, defaults to cook-book
DB_USER String User of application database No, defaults to cook-book
DB_PASS String Password of application database No, defaults to cook-book

Development and Running

Cook Book is built with Gradle. Standard Gradle tasks like clean, compileJava, compileTestJava and test can be used.

If you don't have Gradle installed, you can replace gradle commands with ./gradlew to use Gradle wrapper.

To run the application locally:

gradle bootRun --console=plain

Docker

You can create Cook Book database using docker-compose:

docker-compose up -d

This will create database container, then you'll be able to run the application via Gradle.

Docker build can also be customized as follows:

Variable Name Data Type Description Required
DB_PORT Integer Port to bind in the host machine for the database No, defaults to 5432

This way, when you run the stack as following

DB_PORT=1234 docker-compose up -d

you'll be able to access the application the database at jdbc:postgresql://localhost:1234/cook-book.

Contributing

All contributions are welcome. Please feel free to send a pull request. Thank you.

License

Cook Book is licensed with MIT License.

cook-book's People

Contributors

makiftutuncu avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.