Skip to content

Repository files navigation

Simple React Interface with TypeScript and Tailwind CSS

This project is a simple interface built with React, TypeScript, and Tailwind CSS. It includes:

  • A basic login system.
  • A main view with elements like cards, forms, and other basic components.
  • Responsive design using Tailwind CSS.

🚀 Key Features

  • Login page: A simple login interface with basic validation.
  • Main dashboard: A view featuring interactive cards and forms.
  • Componentized structure: Modular and reusable components for scalability.
  • Responsive layout: Fully responsive, ensuring usability across different devices.

🛠 Technologies Used

  • React - A JavaScript library for building user interfaces.
  • TypeScript - A typed superset of JavaScript.
  • Vite - A fast development build tool for React projects.
  • Tailwind CSS - A utility-first CSS framework.

📁 Project Structure

src/ 
├── components/ # Reusable components 
│ ├── Card/ # Card component 
│ ├── Form/ # Form-related components 
│ └── Login/ # Login page and logic 
├── pages/ # Main views 
│ ├── Dashboard.tsx # Main view after login 
│ └── LoginPage.tsx # Login page 
├── hooks/ # Custom hooks 
├── styles/ # Global styles and Tailwind configurations 
├── App.tsx # Root component 
└── main.tsx # Application entry point

📦 Prerequisites

Ensure you have the following installed:


⚙️ Installation

  1. Clone this repository:
    git clone https://github.com/your-username/simple-react-interface.git
    cd simple-react-interface
  2. Install dependencies:
     npm install
     # or with yarn
     yarn install
  3. Start the development server:
     npm run dev
     # or with yarn
     yarn dev
  4. Open your browser at: http://localhost:5173

🖼 Screenshots

Login Page

Main Dashboard


📖 Usage

Login

  1. Enter your credentials on the login page.
  2. After successful authentication, you'll be redirected to the main dashboard.

Main Dashboard

  • View sample cards and interact with basic forms.

📂 Available Scripts

In the project directory, you can run:

npm run dev

npm run build

  • Builds the app for production to the dist folder.

npm run lint

  • Checks your code for linting issues.

✨ Tailwind CSS Setup

The project is styled using Tailwind CSS, configured for simplicity and flexibility.

Adding Custom Styles

To extend Tailwind’s default configuration, modify the tailwind.config.js file:

module.exports = {
  content: ["./src/**/*.{js,jsx,ts,tsx}"],
  theme: {
    extend: {
      colors: {
        primary: "#4CAF50",
        secondary: "#FF5722",
      },
    },
  },
  plugins: [],
};

Global Styles

Global styles are managed in index.css using Tailwind’s utility classes:

@tailwind base;
@tailwind components;
@tailwind utilities;

🌟 Future Enhancements

  • Integration with an API for real data handling.
  • Role-based authentication and dashboard access.
  • Enhanced accessibility and user experience.
  • Improved form validation using libraries like react-hook-form.

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests for improvements or new features.


📝 License

This project is licensed under the MIT License. See the LICENSE file for more details.


✨ Author

Created by AxierPer. Feel free to reach out if you have any questions or suggestions! 🚀

---

### **What’s Different in This Version?**
1. **Tailwind CSS Integration:**
   - Added a dedicated section explaining how Tailwind is configured and used.
   - Included an example of `tailwind.config.js`.

2. **Language:**
   - The entire `README.md` is now in English.

3. **Future Enhancements:**
   - Adjusted to include improvements like role-based authentication and form validation.

---

Feel free to adjust the placeholders (AxierPer) and screenshots to match your actual project. If you need further customization, let me know! 😊

About

This is a simple interface created in React, which I do as a practice to strengthen my Frontend skills, since my strong point is the backend, but I need to reinforce my frontend development with the basic concepts to structure a complete project.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages