Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.4 KB

README.md

File metadata and controls

46 lines (28 loc) · 1.4 KB
Raw

bookshelf-fe

This is the frontend of the bookshelf project. It is built with React.js, Next.js, Redux, TailwindCSS and Chakra UI.

Contributors

  1. Bùi Lê Khánh Linh - Leader / Front-end / Design / Document
  2. Nguyễn Thị Thanh Lan - Back-end / Front-end / Document
  3. Nguyễn Duy Ngọc - Document / Back-end

Project structure module

Project compose 2 git submodules:

  1. Front-end: current repository
  2. Back-end: ./bookshelf-be

Running product

  1. Install dependencies:
yarn install
  1. Run the development server:
yarn dev

For contributors

Please create a new branch for your contribution. DO NOT upload code to the master branch directly.

📌 Naming branch:

There are 2 types of branches:

  • Feature: This type of branch is for creating a new feature, and the functions should be well described in your Pull Request. Pattern: feature/name

  • Fix: Use this type of branch to fix an issue or a set of issues. Pattern: fix/name

The branch name will use kebab case: lowercase words and separated by a dash (-). E.g.: feature/example-new-feature

User interface