Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ChrisUser/vite-complete-react-app

Vite React template with: typescript, axios, sass, react-router, redux toolkit and much more already configured.
https://github.com/ChrisUser/vite-complete-react-app

axios moment react redux-toolkit typescript vite

Last synced: 1 day ago
JSON representation

Vite React template with: typescript, axios, sass, react-router, redux toolkit and much more already configured.

Awesome Lists containing this project

README

        

New React App

# Usage

To clone and use this template type the following commands:

```sh
npx degit chrisuser/vite-complete-react-app my-app
```

```sh
cd my-app
```

Then, based on your package manager:

## npm

```sh
npm install
```

```sh
npm run dev
```

## yarn

```sh
yarn
```

```sh
yarn dev
```


> [!TIP]
> Remember to update the project name inside the `package.json` file.


## โš—๏ธ Technologies list

- [TypeScript](https://www.typescriptlang.org/)
- [Sass](https://sass-lang.com/)
- [Redux Toolkit](https://redux-toolkit.js.org/)
- [Router](https://reactrouter.com/)
- [Axios](https://axios-http.com/)
- [Moment](https://momentjs.com/)
- [ESlint](https://eslint.org/) & [Prettier](https://prettier.io/)

---


> [!TIP]
> After cloning the repo you can delete all the previous text for a cleaner README.


This is a blank README file that you can customize at your needs.\
Describe your project, how it works and how to contribute to it.


# ๐Ÿš€ Available Scripts

In the project directory, you can run:


## โšก๏ธ start

```
npm start
```

or

```
yarn start
```

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.


## ๐Ÿงช test

```
npm test
```

or

```
yarn test
```

Launches the test runner in the interactive watch mode.


## ๐Ÿฆพ build

```
npm build
```

or

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


## ๐Ÿงถ lint

```
npm lint
```

or

```
yarn lint
```

Creates a `.eslintcache` file in which ESLint cache is stored. Running this command can dramatically improve ESLint's running time by ensuring that only changed files are linted.


## ๐ŸŽฏ format

```
npm format
```

or

```
yarn format
```

Checks if your files are formatted. This command will output a human-friendly message and a list of unformatted files, if any.


# ๐Ÿงฌ Project structure

This is the structure of the files in the project:

```sh
โ”‚
โ”œโ”€โ”€ public # public files (favicon, .htaccess, manifest, ...)
โ”œโ”€โ”€ src # source files
โ”‚ โ”œโ”€โ”€ __tests__ # all test files
โ”‚ โ”œโ”€โ”€ components
โ”‚ โ”œโ”€โ”€ pages
โ”‚ โ”œโ”€โ”€ resources # images, constants and other static resources
โ”‚ โ”œโ”€โ”€ store # Redux store
โ”‚ โ”‚ โ”œโ”€โ”€ actions # store's actions
โ”‚ โ”‚ โ””โ”€โ”€ reducers # store's reducers
โ”‚ โ”œโ”€โ”€ styles
โ”‚ โ”œโ”€โ”€ types # data interfaces
โ”‚ โ”œโ”€โ”€ utility # utilities functions and custom components
โ”‚ โ”œโ”€โ”€ App.tsx
โ”‚ โ”œโ”€โ”€ index.tsx
โ”‚ โ”œโ”€โ”€ RootComponent.tsx # React component with all the routes
โ”‚ โ”œโ”€โ”€ serviceWorker.ts
โ”‚ โ”œโ”€โ”€ setupTests.ts
โ”‚ โ””โ”€โ”€ vite-env.d.ts
โ”œโ”€โ”€ .env
โ”œโ”€โ”€ .eslintignore
โ”œโ”€โ”€ .eslintrc.js
โ”œโ”€โ”€ .gitignore
โ”œโ”€โ”€ .prettierrc
โ”œโ”€โ”€ index.html
โ”œโ”€โ”€ jest.config.cjs
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ tsconfig.json
โ””โ”€โ”€ vite.config.json
```

# ๐Ÿ“– Learn More

You can learn more in the [Vite documentation](https://vitejs.dev/guide/).

To learn React, check out the [React documentation](https://reactjs.org/).

#

Bootstrapped with Vite.