JohnFTitor / hello-react-front-end

Simple React Frontend for the Rails API project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Hello React Frontend

Simple React frontend for hello rails backend

Important note: MaKe sure your server is running at port 3000, since the CORS set up in the backend only allows that port to be fecth the data from the API

Backend

The backend of the project can be found here

Built With

  • HTML/SCSS and JavaScript
  • React Framework, Redux, Redux Toolkit
  • Jest

Getting Started

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

  • Clone this repository with git clonegit@github.com:JohnFTitor/hello-react-front-end.git using your terminal or command line.
  • Change to the project directory by entering :
    cd hello-react-front-end in the terminal

Prerequisites

You need to make sure to have installed the latest version of Node.js and npm on your computer.

Setup

You can clone this repository or simply download the files as a .zip If you want to set up a personal repository based on this one, you can as well fork it.

Install

After clone it and before working on it, you have to run npm install so that all the dependencies of the project get downloaded in your pc locally. Such dependencies include React app and linters checks, for which you have to install the files following the wget commands inside linters.yml file.

Usage

You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below

To work on the project, run npm start in your terminal to deploy a live version of the development. This works in watch mode so it automatically reloads any need change you make to the files.

Run linters checks

Linter Checks are automatically run with Github actions when there's a pull request. If you want to run them locally, remember to have the config file in the root of the local project.

Testing

Run npm test to check prepared test cases related to the website functionality simulating user interaction.

Authors

👤 Andrés Felipe Arroyave Naranjo

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.

About

Simple React Frontend for the Rails API project


Languages

Language:JavaScript 50.9%Language:HTML 31.2%Language:CSS 17.9%