PORTFOLIO FRONTEND

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

This repository will be the repository containing the the frontend of the Portfolio.

The main functionality of this app is to make a visual page that retrieves the data from a backend or from a data file.

Built With

The frameworks/libraries used to complete this project are:

• React
• Yarn
• Vite

(Back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Before installing the software you must have installed the npm package. You can do it using the next command.

• npm

  npm install --global yarn

Installation

The steps to get working the project are the following ones:

1. Clone the repo

   git clone https://github.com/Mariovido/portfolio-frontend.git

2. Run the following command.

   yarn install

3. Create an .env file called .env on the root directory and fill the fields with your data.

   VITE_REACT_APP_USE_SERVER="ENTER IF YOU'RE USING AN API"
   VITE_REACT_APP_WEB_TITLE="ENTER YOUR TITLE OF THE PAGE"
   VITE_REACT_APP_BASE_URL="ENTER YOUR BASE URL"
   VITE_REACT_APP_BACKEND_URL="ENTER YOUR BACKEND URL"
   VITE_REACT_APP_USER_ID="ENTER YOUR USER ID"

(Back to top)

Usage

To start using the app you need to run the following steps:

1. Open a terminal on the root folder
2. If you want to use it in dev purpose run the following command

   $ yarn dev

3. If you want to use it to run the tests run the following commands

   # unit tests
   $ yarn test
   
   # test coverage
   $ yarn test:cov

4. If you want to test if your build is working run the following commands

   # build the app
   $ yarn build
   
   # runs the built app
   $ yarn preview

License

Distributed under the MIT License. See LICENSE for more information.

(Back to top)

Contact

Your Name - @mariovido - [email protected]

Project Link: https://github.com/Mariovido/portfolio-frontend

(Back to top)