Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/remrkabledev/react-basics

An introduction to React.js using a collection of example applications
https://github.com/remrkabledev/react-basics

react react-component react-hooks react-router react-router-dom reactjs

Last synced: about 2 months ago
JSON representation

An introduction to React.js using a collection of example applications

Awesome Lists containing this project

README

        

# React Basics

A collection of React.js concepts

This application is built with [React.js](https://reactjs.org/)

## Getting Started ๐Ÿ

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

What things you need to install the software and how to install them

```
NPM / Yarn
Code Editor (This app was built on VSCode)
Git
```

### Installing

To get this project on your local machine, you first need to clone it using the `git clone` command.

```
git clone https://github.com/reMRKableDev/react-basics.git
```

Running this on your terminal will ensure you receive the latest version with all it's changes.

Once you've cloned, navigate into the project folder and run

```
npm install
```

This should retrieve all the necessary dependencies named in the `package.json` file.

## Running the tests ๐Ÿงช

This app utilizes Jest & Enzyme for testing the components. Tests can be run by using the command:

```
npm test

OR

npm run test
```

To run tests with coverage, use the command:

```
npm run coverage
```

## Contributing ๐Ÿ‘‹

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note that there is a code of conduct, please follow it in all your interactions with the project.

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

## Authors ๐Ÿ’ป

- **Malcolm R. Kente** - _Initial work_ - [reMRKable Dev](https://remrkabledev.com/)
- **Lloyd Chambrier** - _Maintenance work_ - [Lloyd Chambrier](https://lloydc.github.io/)

## Acknowledgments ๐Ÿ—ฃ๏ธ

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).