Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/4kauanmota/create-react-toolkit


https://github.com/4kauanmota/create-react-toolkit

css html javascript jest jsx npm-package react typescript visual-studio-code webpack

Last synced: 3 days ago
JSON representation

Awesome Lists containing this project

README

        

![Project Stars](https://img.shields.io/github/stars/4kauanmota/create-react-toolkit?color=1e90ff) ![Project Commits Week](https://img.shields.io/github/commit-activity/w/4kauanmota/create-react-toolkit?color=1e90ff)

# 📄 **Informations**

This is a project created to improve my knowledge in web configurations. It's a like create-react-app, but already configured with modern technologies (more details below).


# ✨ **Features**

**Configured for use:**

- Typescript
- Sass
- Jest
- Babel
- React Router Dom
- Modules


# 💻 **Technologies**

- [HTML](https://developer.mozilla.org/pt-BR/docs/Web/HTML)
- [CSS](https://developer.mozilla.org/pt-BR/docs/Web/CSS)
- [JAVASCRIPT](https://developer.mozilla.org/pt-BR/docs/Web/JavaScript)
- [TYPESCRIPT](https://www.typescriptlang.org/)
- [JEST](https://jestjs.io/)
- [NPM](https://www.npmjs.com/)
- [REACT](https://react.dev/)
- [JSX](https://pt-br.legacy.reactjs.org/docs/introducing-jsx.html)
- [WEBPACK](https://webpack.js.org/)
- [VISUAL STUDIO CODE](https://code.visualstudio.com/)


# ⚙️ **How to run**

### Requirements

- [GIT](https://git-scm.com/)
- [NODE.JS](https://nodejs.org/en)

### Codes

- `npx create-react-toolkit@latest my-app`

|

### 1. Creating project

You will need to open the terminal in the folder where you want to create the project, and then, you paste this code:

```
npx create-react-toolkit@latest my-app
```

After the command has finished executing, your project will be created and you can enter the project folder and start using it :)

PS: Instead of **my-app** you can enter the name that you want for your project.


# 📱 **Scripts**

To start the dev server and see how your site is looking:

```
npm start
```

|

To build the entire projet in the form that will be sent to the deploy:

```
npm run build
```

|

To run your test files:

```
npm test
```


# 📝 **Author**

[Kauan Soares Mota](https://github.com/4kauanmota)