COOK

Personal cookbook
Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
• Usage
• Roadmap
• Contributing
• License
• Acknowledgements

About The Project

COOK is a single-user application for managing personal cooking recipes.

Built With

Based on modern web technologies and frameworks, COOK is built using:

• Spring Boot
• React

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Java 13

Usage

• For starting COOK, switch to the server directory and use the command below:

  ./mvnw spring-boot:run

• To run all unit tests, issue the following command:

  ./mvnw test

For more examples, please refer to the Documentation.

Roadmap

See the GitHub Project for a list of features which are currently in development.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project
2. Create your feature branch:

   git checkout -b feature/COOK_<issue_ID>

3. Commit your changes:

   git commit -m 'COOK-<issue_id> <short_description> <list_of_author_initials>'
   # Example (author: John Doe): git commit -m 'COOK-003C Implement certain functionality [DJ]'

4. Push to the feature branch:

   git push origin feature/COOK_<issue_ID>

5. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

• README template