#FALL24 hack — frontend

Contents

1. Tech stack
   1. Dependencies
2. Getting started
   1. Requirements
   2. Install
      1. By git clone
3. Contribute
4. Useful links

Tech stack

Dependencies

1. TaiwindCSS
2. Shadcn-UI
3. Lucida Icons
4. Vitest

Getting Started

Requirements

• node.js and npm
• git

Install

By git clone

Use following commands:

# clone the repository
git clone git@github.com:InTeam-Russia/fall24hack-frontend.git
cd fall24hack-frontend

# install yarn
npm i -g yarn

# setup project
yarn
yarn dev

Contribute

Follow this steps to make this repo clean

1. Always do extra check for code style before committing, using:

yarn format
yarn lint
yarn test # if nessesary

2. Use conventional commits

3. Do not push direct into main. Insead, use pull requests

4. Do not use GitHub to make commits — they're probably won't pass lint check. And, if you did, do this manually:

• If bad commit is last

git pull origin <branch>
yarn format
git commit --amend -m "use same commit message"
git push origin <branch> --force-with-lease

• If bad commit is not last

git pull origin <branch>
yarn format
git commit -m "chore: format bad commit"

git log # find commit with hash e.x. `COMMIT` that is at least two commits higher than bad
git rebase -i COMMIT

# Do interactive rebase - select your fix commit and replace `pick` with `f`. Save and quit your git editor

git log # check if your fix commit is disappeared

git push origin <branch> --force-with-lease

Useful links

1. Svelte docs
2. SvelteKit docs
3. SvelteKit docs (in russian)
4. Shadcn-svelte docs
5. TailwindCSS official website