Iced-Latte (Frontend)
[](https://github.com/Sunagatov/Iced-Latte-Frontend/actions) [](https://github.com/danilqa/node-file-router/blob/main/LICENSE) [](https://github.com/Sunagatov/Iced-Latte-Frontend/issues) [](https://github.com/Sunagatov/Iced-Latte-Frontend) [](https://hub.docker.com/r/zufarexplainedit/Iced-Latte-Frontend/) [](https://github.com/Sunagatov/Iced-Latte-Frontend/graphs/contributors) [](https://github.com/Sunagatov/Iced-Latte-Frontend/stargazers)Table of Contents
- Introduction
- Github-Stars
- Iced-Latte (Frontend)
- Table of Contents
- Tech Stack
- Quick Start
- Features
- API Documentation
- Project structure
- Contributing
- Code of Conduct
- License
- Contact
- Community and Support
Introduction
🟥 Iced-Latte (Frontend) 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. Built using Next.js, it's crafted for educational purposes, offering insights into modern application development with Next.js.
🟥 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
- Core: Next.js + Typescript.
- State manager: Zustand.
- Css framework: TailwindCSS.
- Testing: Jest, React-Testing-Library.
Quick Start
Follow the setup instructions in START.MD to get the project up and running.
API Documentation
The API is fully documented with Swagger. Access the documentation at http://localhost:8083/api/docs/swagger-ui once the server is running.
Project structure
- public/ (static files)
- src/ (sources directory)
- app/
- _components/ (components used by current page)
- someRouteFolder/ (some rote page)
- _components/ (someRoute page components)
page.tsx (someRoute page)
globals.css (global styles)
layout.tsx (root layout)
page.tsx (main page)
- components (shared components across application)
- ui (shared ui components (buttons, etc.))
- constants (temporary hardcoded values)
- data (temporary mocked data)
- hooks (custom hooks)
- models (typescript types)
- services
- utils (utility functions)
tailwind.config.ts (tailwind custom classes)
🚢 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
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: zufar.sunagatov@gmail.com.
❤️