Skip to content

This starter provide ready to dev react-app with typescript

Notifications You must be signed in to change notification settings

seeren/react-starter

Repository files navigation

React starter

This starter provide ready to dev react-app with typescript.


💿 Install

Project prerequists are to install globally Node.js or Docker.

Clone this repository.

git clone https://github.com/seeren/react-starter.git

Change directory.

cd react-starter

⌨️ Editor

VScode is sugested with the provided configuration.

Extension

The file .vscode/extensions.json recommand installing folowing extensions:

Settings

The file .vscode/settings.json contain recommanded settings.


🚀 Run

Execute the project on local environement

Npm

  • Install dependencies.
npm install
  • Serve the project.
npm start

Docker

  • Build then run image for developement stage.

Port can be configured in .env file with the PORT variable

docker-compose up dev
  • Build then run image for production stage.

Port can be configured in .env file with the PORT_NGINX variable.

Production rely on nginx with the nginx.conf file to serve build/index.html whatever the url path is.

docker-compose up prod

You can execute commands for react-starter containers with zsh

docker exec -it react-starter_dev zsh

📐 Lint

Enforce code quality and style

Fix lint rules and save file.

npm run lint

Eslint

Lint stack is specific to react typescript and opiniated. There is few rules for encourage to adding them as needed.


👨‍💻 Dev

Learn react practices

Explore project directories README:


🏗️ Build

This section describe how to build the project.

Npm

  • Build the project
npm run build

Docker

  • Build then run image for build stage.
docker-compose up build

About

This starter provide ready to dev react-app with typescript

Resources

Stars

Watchers

Forks

Releases

No releases published