peyssoa / cra-ts-boilerplate

Create React App - Typescript Boilerplate

This boilerplate was built for larger projects that would require more complex structuring.

This README file is just a template, true app details should be filled in as necessary.

---

Few lines describing your project.

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments

🧐 About

Write about 1-2 paragraphs describing the purpose of your project.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

Give examples

Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo.

🔧 Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

🎈 Usage

Add notes about how to use the system.

🚀 Deployment

Add additional notes about how to deploy this on a live system.

⛏️ Built Using

• React JS - Web Framework
• MongoDB - Database
• Express - Server Framework
• NodeJs - Server Environment
• etc...

✍️ Authors

• @peyssoa -> Idea & Initial work

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• References