Skip to content

dougllima/react-custom-loader

Repository files navigation

npm Maintainability Test Coverage dependencies Status dependencies Status

React Custom Loader

A simple and customizable react loader.

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.

  • Fork/Clone this repo.
  • Run npm install.
  • Ready to go! ✅

Seting up to contribute

Run the lint command

// Single command, repeat it on each change on files in lib/
npm run lint
// Or run the command above and it will watch for changes
npm run lint:watch

Run the build command

// Single command, repeat it on each change on files in lib/
npm run build
// Or run the command above and it will watch for changes
npm run build:watch

Add a symlink to the project

npm link

Link your project with the symlink

cd your-project-path
npm link react-custom-loader

You can now import the component

import { Loader } from 'react-custom-loader'

Running the tests - TODO

Tell user how to run tests

Break down into end to end tests - TODO

Explain what these tests test and why

And coding style tests - TODO

Explain what these tests test and why

Give an example

Deployment

Copy the content build folder and importe the component from the path build\index.js as above

import { Loader } from 'path-to-build/build/index.js'

Or you can install the last version

npm install react-custom-loader

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

Making based on