Arty is a seed project, bootstrapped with Create React App. But more than that, it is a collection of extensions and patterns that work really well with React and Typescript. Arty consists of 2 repos: Arty Stack and Arty Docs. The stack is the small seed project that includes React configured for Typescript. The docs is the collection of GF markdown docs that describe common pattern, style guides, and extension instructions for using the stack...a sort of recipe book for creating apps with the seed project.
This project was created with the hope to save other teams at Rackspace from having to research and rediscover designs, techniques, and patterns to implement in their software projects.
Arty requires Node v8.7 or above.
Clone the arty-stack repo with Git and either run either npm install
or yarn install
, depending on your preferred Node package manager.
In the project directory, you can run yarn start
or npm start
to run your project in development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Run yarn test
or npm test
to run unit tests.
This launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Run yarn build
or npm run build
to create a set of bundled production files for your app.
This 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 for more information.
Because Arty is based on Create React App, all the documentation for that project is applicable. You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
To learn TypeScript, visit the TypeScript documentation.