Cheerio is a mental health application built using React and Tailwind CSS. This repository contains the frontend code for the project, located inside the frontend
folder.
- Modern UI built with React and Tailwind CSS
- State management with React Hooks
- API communication with Axios
- Component-based architecture for scalability
- Fully responsive design
Cheerio/
├── frontend/
│ ├── src/
│ │ ├── components/ # Reusable UI components
│ │ ├── pages/ # Different application pages
│ │ ├── assets/ # Images, icons, styles
│ │ ├── App.js # Main application component
│ │ ├── index.js # Entry point
│ ├── public/ # Static assets
│ ├── package.json # Project dependencies
│ ├── tailwind.config.js # Tailwind configuration
│ ├── postcss.config.js # PostCSS configuration
├── backend/ (if applicable)
Make sure you have the following installed before proceeding:
- Node.js (v16+ recommended) - Download here
- npm (Comes with Node.js) or yarn
- Git (optional, for version control)
Follow these steps to set up the project:
- Clone the repository:
git clone https://github.com/YashBaviskar1/Cheerio.git cd Cheerio/frontend
- Install dependencies:
npm install # or yarn install
The project uses the following npm packages:
- react - UI library
- react-dom - React for the web
- react-router-dom - For navigation
- axios - API requests
- tailwindcss - Utility-first CSS framework
- postcss - CSS transformations
- autoprefixer - CSS vendor prefixes
- dotenv - Manage environment variables
Start the development server with:
npm run dev # or yarn dev
The app will be available at http://localhost:3000/
.
To create an optimized production build:
npm run build # or yarn build
This will generate a dist/
folder with minified and optimized files.
Create a .env
file in the frontend
directory and add:
VITE_API_BASE_URL=http://your-backend-url/api
Replace http://your-backend-url/api
with the actual API URL.
If you encounter any issues:
- Ensure all dependencies are installed correctly (
npm install
oryarn install
). - Check the Node.js version (
node -v
). - Restart the development server.
- Verify API endpoints in the
.env
file.
This project is licensed under the MIT License.
Made with ❤️ by Yash Baviskar