cra-template-solrachix-typescript

Motivation    |    How to use    |    Technologies    |    How to clone    |    How to contribute    |    License

Original Create React App README available here

💻 Motivation

You know the pain. You start a new project from scratch and need to configure it again and again. It needs routing, ok you setup Router, then you need styled components, ok now then you need axios, eslint... - ok, oh 😩 React boilerplate is taking so much time to type. Wait... what if you could have all the tools you want just from the beginning? I want to focus on building amazing projects and not spending hours configuring. That's why I've created this template. It's here for you to use.

How to use

npx create-react-app your-project-name --template solrachix-typescript

Or

yarn create react-app your-project-name --template solrachix-typescript

npx command installs the most recent stable version of CRA from npm.

--template parameter points to this template, note that cra-template- prefix is omitted.

Due to CRA template limitations (we can change only scripts and dependencies inside generated package.json) all configuration is done by adding config files where possible. For not having the option of devDependencies you will need to install some more libraries by running this command:

yarn add @types/react-router-dom @types/styled-components

Available Scripts

In the project directory, you can run:

• yarn start - runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

• yarn test - launches the test runner in the interactive watch mode.

• yarn build - builds the app for production to the build folder.

• yarn eject - exposes content of react-script package

• yarn lint - lints project files according to eslint rules, see below. Typical use case: continuous integration environments, Travis, CircleCI, etc.

• yarn fix - same as yarn lint, but also fixes errors, when possible. Typical use case: local development environment, git hooks.

🚀 Technologies

This project was developed with the following technologies:

• Axios
• Eslint
• Polished
• React
• React Router Dom
• Styled Components
• TypeScript

ℹ️ How to clone

To clone and run this application, you will need [Git] (https://git-scm.com) installed on your computer.

Install Under construction 🚧

  # Cloning the repository
  $ git clone https://github.com/solrachix/cra-template-solrachix-typescript

  # Accessing THIS project directory
  $ cd './cra-template-solrachix-typescript'

  # Installing the dependencies
  $ yarn OR npm install

🤔 How to contribute

• Fork it;
• Create a branch: git checkout -b my-feature;
• Submit your changes: git commit -m 'feat: My new feature';
• Push your branch: git push origin my-feature.

After merging your receipt request to done, you can delete a branch from yours. After your merging request is made, you can delete your branch.

📝 License

This template is under the MIT license. See the file LICENSE for more details.

---

Done with ❤️ Carlos Miguel 👋