README.md

ANI-Research-Web by IT-PeBune

Table Of Contents

• Table Of Contents
• About The Project
• Built With
• Getting Started
  • Installation
  • Available commands
• Production Environment
  • Hosting
  • Deployement
  • Contributing
• Instructions
• Tags & Auto Versioning
  • Auto Versioning
• Outside Collaborators

About The Project

Frontend application that is serving ANI-Research-Backend API.

Built With

• React 18.x
• Mui 5.x
• Storybook 6.5.x
• Chromatic

Getting Started

To get a copy up and running follow the following steps (it is assumed that basic tools like git, node and yarn are already installed).

Installation

1. Clone the repo

git clone [email protected]:it-pebune/ani-research-web.git

2. CD into the project root directory

cd ani-research-web

3. Install the required Npm Packages

yarn

4. Turn the application on

yarn start

Available commands

• yarn start - Start a development server for react
• yarn build - Build the project for deployment
• yarn test - Run tests
• yarn eject - Remove react-scripts from the project and end up with a plain webpack project
• yarn format - Format files with prettier
• yarn format:check - Check files with prettier
• yarn lint - Check files with ESLint
• yarn lint:fix - Format files with ESLint
• yarn prepare - Autorun to install husky (pre-commit linting)
• yarn release - Run release-it, should only be run by CI
• yarn storybook - Run storybook server locally
• yarn build-storybook - Build static storybook

Production Environment

Reserved for future documentation.

Hosting

Reserved for future documentation.

Deployement

Reserved for future documentation.

Contributing

The following isntructions are made for users with edit permission to this repository:

For outside collaborators check this

Instructions

• Get assigned an issue
• Create a new branch conform with the Tags
• Create a PR pointing to either main or prod
• Review & Publish

Tags & Auto Versioning

Follow a clear workflow when contributing, using the same branch tags:

• - feature/branch-name - New feature from main
• - fix/branch-name - New fix from main
• - hotfix/branch-name - New fix from prod (deployed directly, skips staging)

Auto Versioning

If you want to create a new tag and release when merging a PR you may use the following commit messages:

• [major] - to increase the major version
• [minor] - to increase the minor version
• [skip-release] - to skip the release all together
• no message to increase the patch

Outside Collaborators

• Fork the repository
• Run the getting started steps
• Follow the same instructions as normal contributors