/recipes

Recipes API.

Primary LanguageJavaMIT LicenseMIT

Contributors Forks Stargazers Issues Pull Requests MIT License


Recipes API

A blog recipes API for you to share and search for food recipes
Explore the docs »
· Report Bug · Request Feature · Create Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Discord Server

About The Project

The idea is to have a blog that you can share recipes, consult them, comment them, etc.

(back to top)

Built With

(back to top)

Prerequisites

In order to work with this project locally, you need the following tools setted up:

Running locally

Running with Docker (TODO)

  1. Clone the repo 
    git clone https://github.com/Java-Dojo-Server/recipes
  2. Change directoy into project's folder 
    cd recipes
  3. Change to dev1 profile 
    TODO
  4. Run docker environment 
    docker-compose up

Running without Docker (TODO)

  1. Clone the repo 
    git clone https://github.com/Java-Dojo-Server/recipes
  2. Change directoy into project's folder 
    cd recipes
  3. Change to dev2 profile 
    TODO
  4. Run application 
    mvn spring-boot:run

(back to top)

Usage

  • register as user
  • login as user
  • create posts with recipes
  • comment posts

For more examples, please refer to the Documentation

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

A detailed Contribution Guide can be found at CONTRIBUTING GUIDELINE

(back to top)

License

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

(back to top)

Discord Server

This project is part of a open-source community on discord called Java Dojo. For you to contribute to this project it isn't necessary to be part of it. But in case you want, you can join by following:

Joins us - Discord Invite

(back to top)