Skip to content

Commit

Permalink
feat(cra): supports using CRA to install javascript template (#3538)
Browse files Browse the repository at this point in the history
* feat(cra): supports using CRA to install javascript template

* feat(cra): update template
  • Loading branch information
simonguo committed Jan 9, 2024
1 parent bbe3609 commit 1b697f4
Show file tree
Hide file tree
Showing 21 changed files with 515 additions and 0 deletions.
10 changes: 10 additions & 0 deletions tooling/cra-template/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# @rsuite/cra-template

This is the official rsuite+javascript template for
[Create React App](https://github.com/facebook/create-react-app).

## Usage

```sh
npx create-react-app my-app --template @rsuite
```
30 changes: 30 additions & 0 deletions tooling/cra-template/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "@rsuite/cra-template",
"version": "1.0.1",
"keywords": [
"react",
"create-react-app",
"rsuite",
"template"
],
"description": "The official rsuite+javascript template for Create React App.",
"repository": {
"type": "git",
"url": "https://github.com/rsuite/rsuite.git",
"directory": "tooling/cra-template"
},
"license": "MIT",
"engines": {
"node": ">=14"
},
"bugs": {
"url": "https://github.com/rsuite/rsuite/issues"
},
"files": [
"template",
"template.json"
],
"publishConfig": {
"access": "public"
}
}
16 changes: 16 additions & 0 deletions tooling/cra-template/template.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"package": {
"dependencies": {
"@testing-library/jest-dom": "^5.14.1",
"@testing-library/react": "^13.0.0",
"@testing-library/user-event": "^13.2.1",
"@rsuite/icons": "latest",
"rsuite": "latest",
"react-icons": "^3.0.0",
"web-vitals": "^2.1.0"
},
"eslintConfig": {
"extends": ["react-app", "react-app/jest"]
}
}
}
70 changes: 70 additions & 0 deletions tooling/cra-template/template/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Getting Started with Create React App

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

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
23 changes: 23 additions & 0 deletions tooling/cra-template/template/gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
Binary file added tooling/cra-template/template/public/favicon.ico
Binary file not shown.
43 changes: 43 additions & 0 deletions tooling/cra-template/template/public/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Web site created using create-react-app"
/>
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
<!--
manifest.json provides metadata used when your web app is installed on a
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>React App</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>
Binary file added tooling/cra-template/template/public/logo192.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tooling/cra-template/template/public/logo512.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions tooling/cra-template/template/public/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"short_name": "React App",
"name": "Create React App Sample",
"icons": [
{
"src": "favicon.ico",
"sizes": "64x64 32x32 24x24 16x16",
"type": "image/x-icon"
},
{
"src": "logo192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "logo512.png",
"type": "image/png",
"sizes": "512x512"
}
],
"start_url": ".",
"display": "standalone",
"theme_color": "#000000",
"background_color": "#ffffff"
}
3 changes: 3 additions & 0 deletions tooling/cra-template/template/public/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# https://www.robotstxt.org/robotstxt.html
User-agent: *
Disallow:
15 changes: 15 additions & 0 deletions tooling/cra-template/template/src/App.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@import url("./Logo/Logo.css");

.app-header {
min-height: 100vh;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
font-size: calc(10px + 2vmin);
gap: 20px;
}

.rs-theme-dark .app-header {
background-color: #282c34;
}
51 changes: 51 additions & 0 deletions tooling/cra-template/template/src/App.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import React from 'react';
import { Button, CustomProvider, Container, Stack, Toggle } from 'rsuite';
import { Icon } from '@rsuite/icons';
import { FaMoon, FaSun } from 'react-icons/fa';
import Logo from './Logo';
import './App.css';

function App() {
const [theme, setTheme] = React.useState('dark');

const toggleTheme = checked => {
setTheme(checked ? 'light' : 'dark');
};

return (
<CustomProvider theme={theme}>
<Container className="app">
<header className="app-header">
<Logo />
<p>
Edit <code>src/App.js</code> and save to reload.
</p>

<Toggle
checked={theme === 'light'}
checkedChildren={<Icon as={FaSun} style={{ fontSize: 16 }} />}
unCheckedChildren={<Icon as={FaMoon} style={{ fontSize: 16 }} />}
onChange={toggleTheme}
/>

<Stack spacing={10}>
<Button
appearance="primary"
href="https://rsuitejs.com"
target="_blank"
rel="noopener noreferrer"
>
Learn React Suite
</Button>

<Button href="https://reactjs.org" target="_blank" rel="noopener noreferrer">
Learn React
</Button>
</Stack>
</header>
</Container>
</CustomProvider>
);
}

export default App;
8 changes: 8 additions & 0 deletions tooling/cra-template/template/src/App.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { render, screen } from '@testing-library/react';
import App from './App';

test('renders learn react link', () => {
render(<App />);
const linkElement = screen.getByText(/learn react/i);
expect(linkElement).toBeInTheDocument();
});

0 comments on commit 1b697f4

Please sign in to comment.