Skip to content

Latest commit

 

History

History
84 lines (45 loc) · 3.46 KB

README.md

File metadata and controls

84 lines (45 loc) · 3.46 KB

React Typescript Starter Code

Template granularity: File & code structure, basic react router integration, example types and components.

authored by @zhongeric

Getting started

Click the Use this template button above, in the top level directory run npm install && npm start!

What is this?

Great question. This is the standard typescript create-react-app with react-router, improved file structure and code organization. And, it has some sample code for tricky stuff like typing Props for components and what not.

Lol ok why don't I just use create-react-app

You can, but I think this will save you some time. :)

How do I deploy & publish this?

I recommend Netlify (https://www.netlify.com/), it's free and super simple to use. Make an account and set up a new site from Git. Then link your Github and select your project's repo. And boom, it'll auto deploy whenever you push to main / master.

P.S. If you're getting errors when deploying related to warnings being treated as errors, go into deploy settings and add a new environment variable CI = false

If you don't want to use netlify, there are ways of hosting it yourself ranging from using a web proxy like Nginx to a totally comprehensive solution like Google Cloud App Engine or AWS.

Can I contribute?

Yes! Just make a PR

License

Use for whatever, personal or commercial :)

Here's the lame create react app stuff below


Getting Started with Create React App

This project was bootstrapped with Create React App.

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.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn 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 for more information.

yarn 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.

To learn React, check out the React documentation.