Frontend Setup
This guide will help you set up the Reservium UI (Frontend) for local development.
Prerequisites
Before you begin, ensure you have the following tools installed:
- Node.js (v20+): For Frontend development.
1. Clone the Repository
Fork and clone the frontend repository:
git clone https://github.com/YOUR_USERNAME/reservium-ui.git
cd reservium-ui
2. Set Up and Run
Step A: Install Dependencies
Navigate to the project directory and install the required packages:
npm install
Step B: Start Development Server
Launch the application:
npm start
The app will be available at http://localhost:3000.
3. Branching & Commit Strategy
To maintain a clean project history and automate our release process with Release Please, we follow the Conventional Commits specification.
Commit Types
Every commit message should follow this pattern: type: description (or type(scope): description).
| Type | Section | Icon |
|---|---|---|
feat |
New Features | |
chore |
Updates & Improvements | |
fix |
Fixes | |
refactor |
Refactors | |
docs |
Documentation | |
test |
Tests & Quality | |
ci |
DevOps & CI/CD |
Workflow
- Create a branch: Use a descriptive name starting with the type, e.g.,
feat/ui-dashboard-fix. - Commit changes: Use the types above. This allows us to automatically generate changelogs and manage version tags.
- Push to your fork and create a Pull Request.
Need Help?
If you encounter any issues, please reach out via email.