Description
- This React application is built using create-react-app.
- It uses Tailwind CSS
- The application is generated in JavaScript.
Pre-requisites
Running in dev environment
cd YOUR_APPLICATION
npm install
npm start
.env file
This file contains various environment variables that you can configure.
Folder Structure
.
├── package.json
├── postcss.config.js
├── public
│ ├── assets
│ │ └── images --------- All Project Images
│ ├── favicon.ico
│ ├── index.html
│ ├── manifest.json
│ └── robots.txt
├── README.md
├── src
│ ├── App.jsx
│ ├── assets
│ │ └── fonts ---------- Project fonts
│ ├── components --------- UI and Detected Common Components
│ ├── constants ---------- Project constants, eg: string consts
│ ├── hooks -------------- Helpful Hooks
│ ├── index.jsx
│ ├── pages -------------- All route pages
│ ├── Routes.jsx ---------- Routing
│ ├── styles
│ │ ├── index.css ------ Other Global Styles
│ │ └── tailwind.css --- Default Tailwind modules
│ └── util
│ └── index.jsx ------- Helpful utils
└── tailwind.config.js ----- Entire theme config, colors, fonts etc.
For the project to build, these files must exist with exact filenames:
public/index.html
is the page template;src/index.jsx
is the JavaScript entry point.
You may create subdirectories inside src.
Available Scripts
In the project directory, you can run:
npm start
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
npm test
Launches the test runner in the interactive watch mode.
npm run build
Builds the app for production to the build
folder.
npm run eject
Note: this is a one-way operation. Once you eject
, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject
at any time.
Installing a Dependency
You can install any dependencies (for example, React Router) with npm
:
npm install --save react-router
Alternatively you may use yarn
:
yarn add react-router