VOXCLIPS

Welcome to team-clutch official frontend repo.

The Voxclips frontend is built with React

Getting Started

For development, you will need Node.js installed on your environement. You can download nodejs [here] (https://nodejs.org/en/)add

You should be able to run the following commands after installation:

  node --version

v 19.1.0

After installing nodejs, install yarn. You can install yarn using npm Run the command below to ensure you have yarn installed

  yarn --version

v 1.22.19

Tech stack

Client: React, Redux, TailwindCSS, SASS, Storybook, ESlint

Installation

Clone the repo

  git clone https://github.com/workshopapps/animatedtalkingheads.web.git
  cd animatedtalkingheads.web.git

install the project's dependencies on your local repo

  yarn install

Start the app

  yarn start

Lunch storybook server to view components

  yarn storybook

Styling

You should style your components/pages using any of the following:

• CSS module
• Tailwind CSS.
• SASS Note: Only approved persons can edit the base styles defined in index.css and Tailwind config file

Run yarn lint to check for linter errors and formatt appropriately.

Opening pull request

Now you have the app running on your machine. To make a pull request follow the guide below:

• Ensure you are not working on the main/dev branch!!!
• Create your branch: by checking out of dev branch to your new branch (follow the appropriate naming style)
• Stage and commit your changes to your branch (use a descriptive commit message)
• Push your local branch to the remote repository.
• On your Github, open a pull request with appropriate description of what you have done.
• Wait for your request to be reviewed and approved.

Note: Only team leads and mentors can approve and merge PRs!!!