mnich / IF.Portfolio

This is my portfolio [WIP]

IF.Portfolio

This repository presents my front-end abilities.

---

Table of Contents

• Development
  • Requirements
  • Installation
  • Running
  • Build
  • Updating packages
  • Test & linters
• Environments
• Browsers
• Tests
• Links

---

Development

This app is base on Create React App.

Requirements

• NodeJS >= v10.14.1
• npm >= 6.4.1

Installation

1. Clone project from GitHub repository git clone [e-mail]:furdzik/IF.Portfolio.git or git clone https://github.com/furdzik/IF.Portfolio.git
2. Add alias to your hosts file: 127.0.0.1 if.portfolio.local
3. cd IF.Portfolio
4. Install dependencies npm install

Running

Run

npm start

for starting dev server. Navigate to http://if.portfolio.local:2021/. The app will automatically reload if you change any of the source files.

Build

Run

npm run build

to build project.

* The build artifacts will be stored in the build/ directory.

To run project locally run

cd build

Updating packages

Package.json is strictly connected with package-lock.json. Updating package should have reflection in package-lock. You should also take care of installing exactly specified package version (see package.json suffix)

Test & linters

This project used tools such as:

• Jest
• Testing library for React

for unit testing.

Run

npm run lint

to execute code style analysis (Eslint, SASS Lint etc.).

Run

npm test

to execute the unit tests via Jest

* unit tests and linters run on every git push (add --no-validate flag to omit it - nor recommended)

Environments

Environment	Url
Local	http://localhost:1217/

Browsers support

IE / Edge	Firefox	Chrome	Safari	Opera
Edge	last version	last version	last version	last version

Tests

The whole logic of Redux should be covered by tests and if I had continued with this project I would have done it at the beginning.

Links

• Style guide
• Project structure