Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thenolle/react-template-typescript

Same as my https://github.com/TheNolle/React-Template-JavaScript but using Typescript instead.
https://github.com/thenolle/react-template-typescript

react template

Last synced: 24 days ago
JSON representation

Same as my https://github.com/TheNolle/React-Template-JavaScript but using Typescript instead.

Awesome Lists containing this project

README

        

[![Copyright](https://readme-typing-svg.demolab.com?font=Fira+Code&weight=500&size=50&duration=3000&pause=2000&color=EB87F7&center=true&vCenter=true&width=1000&height=50&lines=Nolly)](https://thenolle.com)

# ReactJS TypeScript App Template
### Preview
![Preview](preview.png)

---

#### Want the lightweight version ?
[Click here to get it!](../../tree/lightweight)

---

#### What is this ReactJS TypeScript Template?

Tired of creating a new ReactJS project from scratch? Even worse by using create-react-app? Well, this is the TypeScript template for you! This template is a basic one using TypeScript, Babel, Webpack, React, React Dom, React Router Dom, SCSS, etc. I don't provide custom things, just a base TypeScript template to replace create react app and to help react developers to use the latest packages.

---

## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development purposes.

### Prerequisites
- Git
> Install [Git](https://git-scm.com/) for your system.
> Check that git is correctly installed by opening a Terminal and doing `git -v`.
- NodeJS
> Install [NodeJS](https://nodejs.org/) (I recommend using [Node Version Manager (Linux)](https://github.com/nvm-sh/nvm) or [Node Version Manager (Windows)](https://github.com/coreybutler/nvm-windows)).
> Check that [NodeJS](https://nodejs.org/) & [npm](https://www.npmjs.com/) are correctly installed by opening a Terminal and doing `node -v` and `npm -v`.

### How to use

#### 1. Clone the repository
##### Command Line
```sh
# Clone the repository
git clone https://github.com/TheNolle/ReactJS-TypeScript-Template
# Enter the cloned repository
cd ReactJS-TypeScript-Template
```

#### 2. Install the required dependencies (Command Line Only)
Open a terminal in the cloned repository
Run the command npm -v to make sure [NodeJS] works there
Run npm install to install the dependencies

#### 3. Run the Application with your modifications
In the same terminal run this: npm run start and enjoy.

---

## Built With
* TypeScript
* Babel
* Webpack
* React
* React Dom
* React Router Dom
* SCSS

## License
The code is open source under the MIT License. However, if you want to use the code for your own projects, you must credit the original author.

## Contact
* [Website](https://thenolle.com)
* [Twitter](https://twitter.com/thenolly_)
* [Discord](https://discord.com/invite/86yVsMVN9z)
* [Patreon](https://patreon.com/_nolly)
* [Ko-Fi](https://ko-fi.com/nolly__)