Coder Social home page Coder Social logo

arty-docs's Introduction

Arty - A React and Typescript coding patterns library

What is Arty?

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.

Why is Arty?

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.

Dependencies

Arty requires Node v8.7 or above.

Creating a new project based on Arty

Clone the arty-stack repo with Git and either run either npm install or yarn install, depending on your preferred Node package manager.

Using Arty

Running

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.

Testing

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.

Building

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.

Learn More

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.