An open API service indexing awesome lists of open source software.

https://github.com/ukm-programming-umdp/procom-kas-fe-user

Frontend Web Aplication for Kas Management - User side
https://github.com/ukm-programming-umdp/procom-kas-fe-user

muiv5 react tailwindcss typescript vite

Last synced: 5 months ago
JSON representation

Frontend Web Aplication for Kas Management - User side

Awesome Lists containing this project

README

          

# Procom Kas Frontend for User

### Requirements

- NodeJS v20.13.1
- NPM v10.5.2

### Development Setup

---

### Clone This Project

### Install

```bash
npm install
```

### Auto Formatter

- Install Prettier extension
- Configure Default Formatter into: Prettier - Code Formatter
- Make sure the auto format run everytime you save the file
- Make sure you open this project without any parent folder (.vscode folder must on on very top)

### Environment variables

- Copy sample.env and rename it to .env
- Ask backend developer for the backend URL
- Update the values with your values

# Development

### Create a new branch

To solve an issue from Backlog, always create a new branch to the related repository. The format is `{type}/{your-issue}`. Example:
`feature/add-middleware`, `fix/cannot-create-user`

---

### Commit changes

Commit at the smallest meaningful changes possible. Give clear and concise commit message:

1. What has been created/modified
2. What will be affected

This will help you and other team member to debug later when there’s a failure. Example commit message:

> add: balance history page

> edit: get user history

> fix: cannot display user list

---

### Run on your local

After making modifications, make sure you can run it on your local. Pay attention to warnings and errors and fix that before continue to next step.

```bash
npm run dev
```

---

### Push to your branch

Push your working modification to **your own branch**.

---

### Make a Pull Request

- Make a pull request into development branch
- Sync your branch by running `git pull origin development`
- Make sure your code still working and remove any conflict
- Create the PR

Give clear PR title message to **each** branch, let the other developer know what you’re trying to merge. Example PR title:

> Feature/Balance Page

> Fix/Cannot display list of user

---

### Main Branches

**Development**

- Every development and testing must be on this branch.
- This branch will using development database.

**Staging**

- Every issues from development, will be cherry-picked into this branch along with versioning.
- THis branch will using production database for final testing.

**Master**

- Full release into production.