ReactTS Starter

A React code base under Typescript and SCSS style sheet to quickly start a React sunglasses application, with preinstalled UI libraries such as: PrimeReact, PrimeFlex, ReactToastify. The folder structure is very easy to understand and makes it easy to integrate functionality (clean code approach). Easy installation and deployment (under Docker).

Installation

• Install my-project with npm

  npm i -g @mandanyaina/reactts-starter
  reactts-starter
  ? Name of your project : < my-project-name>
  Choose the installation mode :  (Use arrow keys)
  ❯ Docker-compose 
    Local npm 
  cd my-project/

• Download from git

  git pull https://github.com/MandaNyAina/reactts-starter-code <my-project>
  cd my-project/

Running with docker compose

  cd my-project/
  docker-compose run app npm start

Running Tests

To run tests of format and lint, run the following command

  npm run format
  npm run checkform
  npm run lint

To run tests of format and lint, run the following command

  npm run test

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

APP_NAME = name of your project

Authors

• @MandaNyAina

License

MIT

Badges