https://github.com/rezappt-gmbh/frontend
A repository for the frontend of the Rezappt application
https://github.com/rezappt-gmbh/frontend
angular recipes
Last synced: over 1 year ago
JSON representation
A repository for the frontend of the Rezappt application
- Host: GitHub
- URL: https://github.com/rezappt-gmbh/frontend
- Owner: Rezappt-GmbH
- Created: 2024-09-15T16:24:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-15T16:29:58.000Z (almost 2 years ago)
- Last Synced: 2025-03-27T18:16:39.052Z (over 1 year ago)
- Topics: angular, recipes
- Homepage:
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌐 Rezappt Frontend
Welcome to the **Rezappt Frontend** repository! This is where we build the user interface for **Rezappt**, the app that allows users to store, maintain, and share their favorite recipes. Rezappt's frontend lets users seamlessly explore, vote on, and export recipes as PDFs for sharing.
---
## 📊 Project Overview
**Current Sprint**: Sprint 12 (⏳ 2024-09-15 - 2024-09-29)
- **Project Manager**:
- [Jane Doe](https://fake-link/jane) 👩💼 (Organized, Detail-Oriented)
- **Developers**:
- [David Brown](https://fake-link/david) 👨💻 (Creative, Frontend Wizard)
---
## 📝 Methodology
We follow a **Scrumban** methodology 📝, blending Scrum's structure with Kanban's flexibility to ensure a continuous workflow and efficient delivery.
- **Sprint Type**: 🛠️ Organizational
- **Sprint Duration**: 2 weeks ⏱️
- **Sprint Daily**: 15 minutes, [Join the meeting here](https://teams.microsoft.com/fake-link) 💬
- **Sprint Planning**: First day of the sprint, [Sprint planning link](https://teams.microsoft.com/fake-link) 📅
- **Sprint Retro**: Last day of the sprint, [Retro link](https://teams.microsoft.com/fake-link) 🔄
---
## ⚙️ Tech Stack
- **Angular**
- **TypeScript**
- **RxJS**
- **SCSS**
- **RESTful API Integration**
---
## 🚀 Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/en/download/) (v16+)
- [Angular CLI](https://angular.io/cli)
- IDE: VS Code or WebStorm
### Installation
1. **Clone the repository**:
```bash
git clone https://your-private-repo-url.git
cd rezappt-frontend
```
2. **Install dependencies**:
```bash
npm install
```
3. **Run the development server**:
```bash
ng serve
```
4. **Open the app in your browser** at `http://localhost:4200`.
---
## 🛠️ Key Features
- **Responsive Design** with mobile-first approach 📱
- **Seamless Recipe Sharing** through intuitive UI 🍽️
- **Integration with Rezappt Backend** for full API support
- **PDF Export** of recipes directly from the UI 📄
---
## 🧪 Testing
We use **Jasmine** and **Karma** for unit testing.
### Running Tests
1. Run the tests using the following command:
```bash
ng test
```
Our testing strategy includes:
- **Unit Tests**: Ensuring individual components work as expected.
- **End-to-End (E2E) Tests**: Testing the user experience through automated workflows.
Test results are automatically reported in our CI pipeline.
---
## 🚀 Release Management
Our releases are automated via GitHub Actions, with builds deployed as Docker images. We follow **semantic versioning** to tag each frontend release.
---
## 🔀 Branching Model
We use **GitHub Flow** for our branching model, promoting simplicity and continuous delivery:
1. **Feature Branches**: Create a branch for each feature or bug fix.
2. **Pull Requests**: Use PRs for peer review and quality control.
3. **Continuous Deployment**: Every PR merged into `main` triggers an automatic deployment.
---
## 🧑💻 Contributing
This is a private repository. For collaboration inquiries, please contact the project manager:
- **Project Manager**: [Jane Doe](https://fake-link/jane) 👩💼
---
Thank you for checking out the **Rezappt Frontend**! 🎉