Ways-frontend NPM

ways-frontend

The delivered solution lets users upgrade their knowledge in a particular sphere through solving different tasks and taking quizzes. There are also useful professional resources and tips of best practices that allow users to stay up to date with their profession. Users have the ability to manage their skills information on Profile page and get the feedbacks from their managers etc.

Technologies that are used in ways-frontend:

A JavaScript library for building user interfaces called React combined with TypeScript which provides a typing system on top of Javascript and other useful features.
For styles are used mainly styled components. Also is provided the possibility of using SASS.
GraphQL is used as a query language for APIs and Apollo is used for fetching data from server.
JavaScript Testing Framework Jest and testing utility Enzyme are used to test React components.
Storybook is used as a user interface development environment and playground for UI components.

Prerequisities

In this project is used 10.16.3 version of Node.JS.

To easily switch between different Node.JS versions we recommend using Node Version Manager (NVM). To install NVM type the following cURL or Wget command:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.1/install.sh | bash

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.1/install.sh | bash

To verify that NVM has been installed, do:

command -v nvm

The output should be nvm if the installation has been successful. Once NVM is available, install and choose needed Node.JS version.

nvm install 10.16.3
nvm use 10.16.3

To check the current version of Node.JS use

nvm current

To read more go to NVM's GitHub Page.

We use yarn as a package manager of the project. On macOS yarn can be installed through the Homebrew package manager.

brew install yarn

For installing yarn on Windows you can go to yarn docs and download the installer or simply use Chocolatey or Scoop.

You can test that yarn is installed by running:

yarn --version

Installing ways-frontend

To install ways-frontend on your local machine clone this repository:

git clone https://github.com/siarhei-arzamasau-itechart/ways-frontend.git

Go to project directory:

cd ways-frontend

Run

yarn

to install all the necessary dependencies.

Using ways-frontend

To start project on your local machine type in the terminal:

yarn start

To run automated tests use:

yarn test

To run Storybook alongside project in development mode type:

yarn storybook

To start deploy project in production use:

yarn build

Before contributing to ways-frontend you should read our SDLS.

Contact contributors

kharuk - Харук Анастасия - Anastasiya.Kharuk@itechart-group.com
scarletcamomile - Строкач Дарья - Darya.Strokach@itechart-group.com
JackFixard - Богушевский Евгений - Evgenii.Bogushevskii@itechart-group.com
siarhei-arzamasau-itechart - Арзамасов Сергей - siarhei.arzamasau@itechart-group.com
DashaKavalenka - Коваленко Дарья - Darya.Kavalenka@itechart-group.com
CS313 - Савчук Катерина - Katsiaryna.Savchuk@itechart-group.com