Skip to content

Commit

Permalink
Merge pull request #203 from banagale/172/note-about-devserver-config
Browse files Browse the repository at this point in the history
Updated Documentation
  • Loading branch information
patricklafrance authored Nov 4, 2020
2 parents 1fea189 + 1912be6 commit c1f3ec2
Show file tree
Hide file tree
Showing 2 changed files with 240 additions and 136 deletions.
43 changes: 26 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,38 @@ All you have to do is create your app using [create-react-app](https://github.co

## Support

- CRA 3.*
- Create React App (CRA) 3.*
- Yarn
- Yarn Workspace
- NPM
- Lerna (with or without hoisting)
- Custom `react-scripts` version

## Guide

- [Installation](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#installation) - How to install and setup `craco`.
- [Custom location for craco.config.js](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#custom-location-for-cracoconfigjs) - Customize the location of your craco.config.js file.
- [Configuration Overview](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#configuration-overview) - Quickly see how you can configure your CRA installation with this plugin.
- [API](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#api) - Have a look at CRACO API for Jest and Webpack.
- [Recipes](https://github.com/sharegate/craco/tree/master/recipes) – Short recipes for common use cases.
- [Develop a Plugin](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#develop-a-plugin) - How to develop a plugin for `craco`.

## Changelog

Major changes are available in the [changelog folder](https://github.com/sharegate/craco/tree/master/changelog).
## Documentation
- [Installation](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#installation)
- [Configuration](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#configuration)
- [The Mode Property](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#the-mode-property)
- [Sample CRACO Configuration File](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#sample-craco-configuration-file)
- [Setting a Custom Location for `craco.config.js`](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#setting-a-custom-location-for-cracoconfigjs)
- [`when` Shortcuts](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#when-shortcuts)
- [Extra Help for React and Webpack Toolchain Beginners](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#extra-help-for-react-and-webpack-toolchain-beginners)
- [Notes on CRA Configurations and Problem Solving](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#notes-on-cra-configurations-and-problem-solving)
- [Ejecting CRA to Learn](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#ejecting-cra-to-learn)
- [Direct Versus Functional Config Definitions](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#direct-object-literal-versus-functional-config-definitions)
- [API](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#api) - Access CRACO-generated configurations for Jest and Webpack
- [Jest Config Generation](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#jest-config-generation)
- [Webpack DevServer and Production Config Generation](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#webpack-devserver-and-production-config-generation)
- [Recipes](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#recipes)
- [Plugins](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#plugins)
- [Available Plugins](#community-maintained-plugins) - Plugins maintained by the community.
- [Developing a New Plugin](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#developing-a-new-plugin) - How to develop a plugin for CRACO.
- [Plugin Functions](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#plugin-functions)
- [Utility Functions for Development](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#utility-functions-for-development)
- [Debugging](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#debugging)
- [Verbose Logging](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#verbose-logging)
- [License](#license)

## Community Maintained Plugins

* [craco-preact](https://github.com/FormAPI/craco-preact) by [@FormAPI](https://github.com/FormAPI)
* [craco-less](https://github.com/FormAPI/craco-less) by [@FormAPI](https://github.com/FormAPI)
* [craco-antd](https://github.com/FormAPI/craco-antd) by [@FormAPI](https://github.com/FormAPI)
Expand All @@ -57,9 +67,8 @@ Major changes are available in the [changelog folder](https://github.com/sharega
* [craco-fast-refresh](https://github.com/vimcaw/craco-fast-refresh) by [@vimcaw](https://github.com/vimcaw)

## Acknowledgements

[@timarney](https://github.com/timarney) for having created [react-app-rewired](https://github.com/timarney/react-app-rewired).

## License

Copyright © 2019, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
Copyright © 2020, Groupe Sharegate inc. This code is licensed under the Apache License, Version 2.0. You may obtain a
copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
Loading

0 comments on commit c1f3ec2

Please sign in to comment.