GithubHelp home page GithubHelp logo

valievkarim / iced-latte Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sunagatov/iced-latte

0.0 0.0 0.0 6.9 MB

a online Marketplace for coffee retail (Backend)

Home Page: https://iced-latte.uk

License: MIT License

Java 99.94% Dockerfile 0.06%

iced-latte's Introduction


Iced-Latte

ci Status license GitHub issues

Docker Pulls GitHub contributors GitHub stars

Table of Contents

Introduction

๐ŸŸฅ Iced-Latte (Backend) is a non-profit sandbox project where a team of IT enthusiasts are working on creating a modern marketplace (https://iced-latte.uk/) for selling coffee in order to pump up their soft and hard skills and have fun working on an interesting project.

๐ŸŸฅ It's crucial to note that we operate without financial support from any party, and we don't compensate anyone financially either. Our efforts are fuelled solely by passion and dedication.

๐Ÿ”ฅ Github-Stars ๐Ÿ”ฅ

Please support Iced Latte project by Giving Stars ๐ŸŒŸ on Github repositories - your ratings mean a lot to us!๐Ÿ™‚

Tech Stack

  • Architecture: Monolith.
  • Computer language: Java 17.
  • Framework: Spring Web, Spring Boot 3, Spring Data, Spring Security, Spring Actuator, Spring Web, Spring Retry, Lombok, Apache Commons, Spring Mail, Google Guava.
  • Security: JWT, TLS.
  • Migration tool: Liquabase.
  • Logging: Log4j2, Slf4j.
  • Unit Tests: JUnit 5.
  • E2E Tests: Rest Assured, Test containers.
  • Converter: Mapstruct.
  • Test coverage: Jacoco.
  • API Specs: Open API + Spring Docs.
  • Validation: Javax validation.

Quick Start

Follow the setup instructions in START.MD to get the project up and running.

๐Ÿšข Deployment

No k8s, no AWS, we ship dockers directly via ssh and it's beautiful!

The entire production configuration is described in the docker-compose.local.yml file.

Then, Github Actions have to take all the dirty work. They build, test and deploy changes to production on every merge to master (only official maintainers can do it).

Explore the whole .github folder for more insights.

We're open for proposals on how to improve our deployments without overcomplicating it with modern devops bullshit.

๐Ÿ›ค Forking and tweaking

Forks are welcome.

Three huge requests for everyone:

  • Please share new features you implement with us, so other folks can also benefit from them, and your own codebase minimally diverges from the original one (so you can sync updates and security fixes) .
  • Do not use our issues and other official channels as a support desk. Use chats.

๐Ÿ™‹โ€โ™‚๏ธ How to report a bug?

  • ๐Ÿ†• Open a new issue.
  • ๐Ÿ”ฆ Please, use a search, to check, if there is already existed issue!
  • Explain your idea or proposal in all the details:
    • Make sure you clearly describe "observed" and "expected" behaviour. It will dramatically save time for our contributors and maintainers.
    • For minor fixes please just open a PR.

๐Ÿ’Ž Now to propose a new feature?

  • Go to our Discussions
  • Check to see if someone else has already come up with the idea before
  • Create a new discussion
  • ๐Ÿ–ผ If it's UI/UX related: attach a screenshot or wireframe

๐Ÿ˜ Contributions

Contributions are welcome.

The main point of interaction is the Issues page.

Here's our contribution guidelines โ€” CONTRIBUTING.md.

The official development language at the moment is English, because 100% of our users speak it. We don't want to introduce unnecessary barriers for them. But we are used to writing commits and comments in Russian and we won't mind communicating with you in it.

๐Ÿ˜Ž I want to write some code

  • Open our Issues page to see the most important tickets at top.
  • Pick one issue you like and leave a comment inside that you're getting it.

For big changes open an issues first or (if it's already opened) leave a comment with brief explanation what and why you're going to change. Many tickets hang open not because they cannot be done, but because they cause many logical contradictions that you may not know. It's better to clarify them in comments before sending a PR.

๐ŸšฆPay attention to issue labels!

๐ŸŸฉ Ready to implement

  • good first issue โ€” good tickets for first-timers. Usually these are simple and not critical things that allow you to quickly feel the code and start contributing to it.
  • bug โ€” if something is not working, it needs to be fixed, obviously.
  • high priority โ€” the first priority tickets.
  • enhancement โ€” accepted improvements for an existing module. Like adding a sort parameter to the feed. If improvement requires UI, be sure to provide a sketch before you start.

๐ŸŸจ Discussion is needed

  • new feature โ€” completely new features. Usually they're too hard for newbies, leave them for experienced contributors.
  • idea โ€” discussion is needed. Those tickets look adequate, but waiting for real proposals how they will be done. Don't implement them right away.

๐ŸŸฅ Questionable

  • ยฏ\_(ใƒ„)_/ยฏ - special label for questionable issues. (should be closed in 60 days of inactivity)
  • [no label] โ€” ticket is new, unclear or still not reviewed. Feel free to comment it but wait for our maintainers' decision before starting to implement it.

๐Ÿ‘ Our top contributors

Take some time to press F and give some respects to our best contributors, who spent their own time to make the club better.

๐Ÿ˜Ž Iced Latte project creator / Product owner / Tech Lead

๐Ÿ˜‡ Project manager

๐Ÿ•ต๏ธโ€โ™€๏ธ QA engineers

โš™๏ธ Backend developers

๐Ÿ–ฅ๏ธ Frontend developers

๐ŸŽจ UX/UI designers

๐Ÿ“Š Business and system analysts

Let's press F to pay respects to these awesome contributors!

๐Ÿ‘ฉโ€๐Ÿ’ผ License

MIT

In other words, you can use the code for private and commercial purposes with an author attribution (by including the original license file or mentioning the Club ๐ŸŽฉ).

๐Ÿ“ž Contact (Community and Support)

Join our IT community Zufar Explained IT on Telegram.

Feel free to contact us via email: [email protected].

โค๏ธ

iced-latte's People

Contributors

sunagatov avatar reyzis2021 avatar annstriganova avatar nnick44 avatar vpshvd avatar uladzislaum avatar vitaliibredun avatar shpali4 avatar yevr19 avatar kalachyand avatar korzhhiik avatar m437a avatar andrew13pol avatar vova200020 avatar alexkasuka avatar plakhov avatar dbandarovich avatar sumitx28 avatar dependabot[bot] avatar ilyasgaifullin avatar alexandrsergei4 avatar rvze avatar sanya124 avatar sardorjumamuratov avatar wwownow avatar anastasiasafargalieva avatar s083r 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.