https://github.com/saba-var/folksoul-front
FolkSoul is a music band platform where we can find out about the band and its members or just enjoy the visuals.
https://github.com/saba-var/folksoul-front
cypress react-hook-form reactjs tailwindcss typescript
Last synced: about 2 months ago
JSON representation
FolkSoul is a music band platform where we can find out about the band and its members or just enjoy the visuals.
- Host: GitHub
- URL: https://github.com/saba-var/folksoul-front
- Owner: Saba-Var
- Created: 2022-06-24T08:19:10.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T08:41:31.000Z (about 2 years ago)
- Last Synced: 2025-08-19T23:49:25.607Z (10 months ago)
- Topics: cypress, react-hook-form, reactjs, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 6.44 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
FolkSoul is a music band platform where we can find out about the band and its members or just enjoy the visuals.
#
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Prerequisites](#prerequisites)
- [Tech Stack](#tech-stack)
- [Getting Started](#getting-started)
- [Testing](#testing)
- [Project Structure](#project-structure)
- [Resources](#resources)
## Prerequisites
- 
_Node JS @12.X and up_
- 
_npm @6 and up_
#
## Tech Stack
- 
[React @18.2.0] - front-end framework
- 
[Typescript @4.7.4] - JavaScript with syntax for types.TypeScript is JavaScript with syntax for types
- 
[React Hook Form @7.32.2] - flexible and extensible forms with easy-to-use validation
- 
[cypress @10.3.0] - JavaScript End to End Testing Framework
- 
[tailwindcss @3.1.3] - css framework
#
## Getting Started
1\. First of all you need to clone repository from github:
```sh
git clone https://github.com/Saba-Var/Folksoul-front.git
```
2\. Next step requires install all the dependencies.
```sh
npm install
```
or
```sh
yarn install
```
3\. copy .env
```sh
cp .env.example .env
```
4\. after that you can run FolkSoul application from terminal:
```sh
npm start
```
Runs the app in the development mode. Open http://localhost:3000 to view it in your browser.
#
## Testing
1\. copy cypress.config.ts
```sh
cp cypress.config.ts.example cypress.config.ts
```
2\. Run application from the terminal
```sh
npm start
```
3\. start cypress
```sh
npx cypress open
```
In order to see coverage of testing go to coverage/lcov-report and open index.html
#
## Project Structure
```bash
├─── cypress
├─── readme
├─── src
│ ├── assets
│ │
│ ├── components
│ │ ├── component-file.tsx
│ │ ├── index.ts
│ │ ├── types.d.ts
│ │ └── svgs
│ │ ├── svg-file.tsx
│ │ ├── index.ts
│ │ └── types.d.ts
│ │
│ ├── helpers
│ │ ├── helper-file.ts
│ │ ├── index.ts
│ │ └── types.d.ts
│ │
│ └── pages
│ └── page-folder
│ ├── component-folder [#OPTIONAL]
│ │ ├── component-file.tsx
│ │ ├── index.ts
│ │ └── types.d.ts [#OPTIONAL]
│ ├── page-file.tsx
│ ├── index.ts
│ └── types.d.ts [#OPTIONAL]
- .babelrc
- .env
- .eslintrc.json
- .gitignore
- .prettierrc.json
- cypress.config.ts
- package.json
- tailwind.config.js
- tsconfig.json
```
#
## Resources
- [Application Design [Figma]](https://www.figma.com/file/ferG8kznuy5s0hMhMZa2Hi/FolkSoul---Bootcamp?node-id=0%3A1)
- [Application Design Prototype](https://www.figma.com/proto/ferG8kznuy5s0hMhMZa2Hi/FolkSoul-Bootcamp?node-id=0%3A1&scaling=contain&page-id=0%3A1)
- [Git commit rules](https://redberry.gitbook.io/resources/git-is-semantikuri-komitebi)
- [Font [BPG Arial]](https://fonts.ge/ka/font/13/BPG-Arial)
- [Font [BPG Nino Mtavruli]](https://fonts.ge/ka/font/143/BPG-Nino-Mtavruli)