README.md

React Js Starter

This is a starter project for React Js.

The project is helpful to start your next project, as it provides a lot of the common tools you may reach for, all ready to go.

Features

• TypeScript Included.
• Authentication.
• Base pages for Forgot Password, Reset Password, Home, Login, Register, Profile & 404.
• Pre-configured with CSS-in-JS styling.
• Pre-configured with code quality tools: Prettier, TypeScript, Jest, etc.

Directory Structure

Name	Description
build/	Compiled source files will be placed here.
public/	Static assets (fonts, css, js, img).
scripts/	Automation scripts such as generate-icons.
src/	Source files.
src/api	Api endpoints.
src/components	React components including shared (common) components.
src/lib	Utility functions.
src/pages	React views - screen components.
src/routes	Application routes.
src/styles	App style including css & scss.
src/templates	Templates for components generated with generate:component.

Requirements

• Node.js v14 or newer.

Installation

• Clone the repo - git clone https://github.com/kutia-software-company/react-js-starter.
• Install project dependencies — npm install.
• Launch the app — npm run start, it will become available at http://localhost:3000.

Available Scripts

• start
• build
• test
• eject
• start:clean
• start:clean
• start:reset
• generate:icons
• generate:images
• generate:component
• generate:page
• update
• code:format
• code:check
• code:format:specific-file

Related Projects

• Node.js TypeScript API Starter.

License

MIT.

---

^{Made with ♥ by Gentrit Halili (@gentrithalili1).}