An open API service indexing awesome lists of open source software.

https://github.com/saba-var/coronatime

Coronatime shows you current covid situation in the world with statistics of countries.
https://github.com/saba-var/coronatime

cypress i18next javascript reack-hooks-form reactjs tailwindcss typescript

Last synced: about 2 months ago
JSON representation

Coronatime shows you current covid situation in the world with statistics of countries.

Awesome Lists containing this project

README

          


logo

---

Coronatime shows you current covid situation in the world with statistics of countries.

#

## 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.0.0](https://reactjs.org) - front-end framework
- [Typescript @4.6.4](https://www.typescriptlang.org/) - TypeScript is JavaScript with syntax for types.
- [React Hook Form @7.30.0](https://react-hook-form.com/) - flexible and extensible forms with easy-to-use validation.
- [tailwindcss @3.0.24](https://tailwindcss.com/) - css framework
- [cypress @9.6.0](https://www.cypress.io/) - JavaScript End to End Testing Framework
- [I18next @21.8.3](https://www.i18next.com/) - I18next is an internationalization-framework written in and for JavaScript.

#

## Getting Started

1\. First of all you need to clone repository from github:

```sh
git clone https://github.com/Saba-Var/Coronatime.git
```

2\. Next step requires install all the dependencies.

```sh
npm install
```

or

```sh
yarn install
```

3\. after that you can run 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.json

```sh
cp cypress.json.example cypress.json
```

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 # project test files
├─── readme # readme assets
├─── src # project source codes
│ ├── assets # project images
│ ├── components # reusable components
│ │   └── svgs # svg components
│ ├── pages # project pages
│ │   ├── ConfirmationEmail
│ │   │   └── components # page components
│ │   ├── ConfirmedEmail
│ │   │   └── components # page components
│ │   ├── Country
│ │   │   └── components # page components
│ │   ├── Dashboard
│ │   │   └── components # page components
│ │   ├── LogIn
│ │   │   └── components # page components
│ │   ├── NewPassword
│ │   │   └── components # page components
│ │   ├── PasswordConfirmation
│ │   │   └── components # page components
│ │   ├── RecoveryPasswordByEmail
│ │   │   └── components # page components
│ │   ├── SignUp
│ │   │   └── components # page components
│ │   └── Worldwide
│ │      └── components # page components 
│ └── state # context api
- .eslintrc.json # eslint config file
- .gitignore # gitignore config file
- .prettierrc.js # prettier config file
- cypress.json # cypress config file
- jsconfig.json # config file for absolute path
- package.json # dependency manager configurations
- tailwind.config.js # tailwindcss config file
- tsconfig.js # typescript config file

```

#

## Resources

- [Application Design [Figma]](https://www.figma.com/file/O9A950iYrHgZHtBuCtNSY8/Coronatime?node-id=0%3A1)
- [Application Design Prototype](https://www.figma.com/proto/O9A950iYrHgZHtBuCtNSY8/Coronatime?node-id=0%3A1&scaling=min-zoom&page-id=0%3A1)
- [Git commit rules](https://redberry.gitbook.io/resources/git-is-semantikuri-komitebi)
- [Font [Inter]](https://fonts.google.com/specimen/Inter)