No BS React.js (Typescript) Boilerplate

This boilerplate focuses on keeping configuration to a minimum yet supporting all latest Typescript features for making it as easy and worry-free as possible to get started building a performance optimized React.js web application.

This project is open to updates by its users, I ensure that PRs are relevant to the community. In other words, if you find a bug or want a new feature, please help us by becoming one of the contributors ✌️ ! See the contributing section.

🚨 Before continuing:

• If you're creating an API using Express.js consider looking at my No BS Typescript Server Boilerplate
• If you're creating a Javascript/Typescript module consider looking at my No BS Typescript Boilerplate
• If you're creating a Lambda function for AWS consider looking at my No BS Typescript Lambda Boilerplate

Like this project? ❤️

Please consider:

• Buying me a coffee ☕
• Supporting me on Patreon 🏆
• Starring this repo on Github 🌟

How to get started using this boilerplate

The logic of this repo is structured in such a way that all you need to worry about is placing your code in the src directory (using src/index.tsx as entry point).

Running the app

I chose Rollup to handle the transpiling, compression, and any other transformations needed to get your Typescript code running as quickly and performant as possible.

There's two ways of running the app:

Development

yarn dev

Uses concurrently to run Rollup in watch mode (which means it will transpile the bundle js file when you save changes to your code), as well as a combo between an Express.js server and Liveserver which will automagically setup hot-reload functionality so your browser reloads as you modify your source!

Build

yarn build

This command will build the public/bundle.js, uglified and tree-shaken so it loads/runs faster.

This is the recommended hay of producing the production bundle you serve to your final users; after the build completes simply copy the contents of the public directory to a static content delivery service such as AWS S3 or Github Pages, et voilà.

If, on the other hand, you would like to spin up the provided Express.js server with hot-reload turned off, just run:

yarn server

What about tests, styles, etc?

The ethos of this boilerplate is to provide a solid foundation, from there on you are owner of your project and get to decide on the rest of the stack to build upon.

And if you're looking for suggestions here are some that I have tried, tested, and love:

Fast prototyping

• ⚠️ Testing: Jest
• 🎨 Styling: Concise CSS, just pop those <link> tags on the index.html, and className all your components as desired.
• 🌎 Back-end communication: Simply use fetch(), but keep it tidy by setting up reducers with useReducer.
• 📝 State management with persistance: Make a global context with useContext, and persist it with window.localStorage.

Serious production-ready apps

• ⚠️ Testing: Jest
• 🎨 Styling/Components: React Bootstrap, make it easy for yourself, Bootstrap has been the leading UI framework for virtually a decade now, and this React-specific port is well mantained, been stable for quite some time now, and has a community that is both active and helpful.
• 🌎 Back-end communication: Whether it's GraphQL or REST, can't go wrong with Apollo (apollo-link-rest for REST APIs).
• 📝 State management with persistance: I honestly just make my own concoctions based on useReducer and useContext and whatever storage solution fits the bill for the project, but if you're looking for something pre-made I hear great things about Redux Toolkit.

Contributing

Yes, thank you! This plugin is community-driven, most of its features are from different authors. Please update the docs and tests and add your name to the package.json file.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jean Lescure 🚧 💻 📓 ⚠️ 💡 📖

Diana Lescure 📖 👀 🎨