Table of Contents
- Introduction
- Github-Stars
- Tech Stack
- Quick Start
- Deployment
- Forking and tweaking
- How to report a bug?
- Now to propose a new feature?
- Contributions
- Code of Conduct
- Our top contributors
- License
- Contact
Introduction
Iced-Latte (Backend) is a non-profit sandbox project where a team of IT enthusiasts are working on creating a modern marketplace for selling coffee. Our project enables us to hone our soft and hard skills while having fun. It’s important to note that we operate without any financial support, driven solely by our passion and dedication!
Github-Stars
Please support the Iced Latte project by giving stars on Github! Your ratings mean a lot to us!
Tech Stack
- Architecture: Monolith.
- Computer language: Java 17.
- Frameworks: Spring Web, Spring Boot 3, Spring Data, Spring Security, Spring Actuator, Spring Retry, Lombok, Apache Commons, Spring Mail, Google Guava.
- Security: JWT, TLS.
- Migration tool: Liquibase.
- 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
To kick off your journey, follow the setup instructions found in START.MD to get the project up and running.
Deployment
No Kubernetes, no AWS! We ship dockers directly via SSH, and it’s seamless! The entire production configuration can be found in the docker-compose.local.yml file. Additionally, our deployment process is beautifully automated using Github Actions, which manage all the dirty work by building, testing, and deploying changes to production upon every merge to master.
Forking and Tweaking
We welcome forks! Here are three key requests for everyone:
- Share any new features you implement to benefit others.
- Avoid using our issues as a support desk. Use chats.
How to Report a Bug?
To report a bug, follow these steps:
- Open a new issue.
- Before creating a new issue, please **use a search** to check if it already exists!
- Provide a detailed explanation of the observed and expected behavior.
- For minor fixes, open a Pull Request (PR) directly.
Now to Propose a New Feature?
To propose a new feature, you can:
- Go to our Discussions.
- Check if your idea already exists.
- Create a new discussion if it’s unique. If it’s UI/UX related, attach a screenshot or wireframe.
Contributions
Contributions are genuinely welcome! Most interaction happens on the Issues page. Please remember that the main language is English.
Code of Conduct
To maintain a positive environment, we have a Code of Conduct that all contributors must adhere to. Please be respectful in both comments and contributions.
Our Top Contributors
Let’s recognize our amazing contributors who spent their time to make this project better:
- Project Creator: @Sunagatov
- Project Manager: @oonovikova
- QA Engineers: @TetianaPerinha, @ilsinyakov, @Diana-Smolnikova
- Backend Developers: @annstriganova, @M437A, @Sunagatov
- Frontend Developers: @iakivpekarskyi, among others.
License
This project is licensed under the MIT License. In simple terms, you can use the code for private and commercial purposes as long as you provide author attribution.
Contact (Community and Support)
We invite you to join our IT community on Telegram: Zufar Explained IT. For any inquiries, feel free to contact us via email at zufar.sunagatov@gmail.com.
Troubleshooting
If you run into any issues, here are some troubleshooting tips:
- Deployment Issues: Ensure that the Docker configuration is correct and that your SSH access is configured properly.
- Build Failures: Review the build logs from GitHub Actions for errors and follow up with the community on discussions.
- Features Not Working: Check the Axios API calls and ensure that endpoint URLs are correctly pointed to your server.
For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.