Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.55 KB

README.MD

File metadata and controls

61 lines (41 loc) · 2.55 KB

Admin Dashboard with Refine

A modern and intuitive Admin Dashboard application built using Refine framework, React, and Ant Design. This application provides powerful management tools for handling tasks and companies, along with user authentication.

Live Demo

You can check the live demo of the project here: Admin Dashboard with Refine

Features

  • User Authentication: Login, Registration, and Password Management
  • Task Management: Add, Edit, and Delete Tasks
  • Company Management: Create, Edit, and List Companies
  • Real-time Data: Live updates using GraphQL subscriptions
  • Pagination & Sorting: Easily manage data display with pagination and sorting
  • Search & Filters: Search and filter tasks and companies
  • Responsive Design: Fully responsive layout with Ant Design components

Technologies Used

  • React: A JavaScript library for building user interfaces.
  • Refine: A framework for building React-based admin panels with ease.
  • Ant Design: A UI library for React that provides a rich set of components.
  • GraphQL: A query language for APIs used to fetch and manipulate data.
  • TypeScript: A superset of JavaScript that adds static types to the language.
  • Vercel: For deployment.

Prerequisites

Make sure you have the following installed on your machine:

  • Node.js (version 14 or higher)
  • npm (version 6 or higher) or yarn

Explanation:

  1. Project Overview: A brief description of the project, its live demo link, and main features.
  2. Technologies Used: A list of the tech stack used in the project.
  3. Getting Started: Step-by-step instructions for setting up the project locally, including prerequisites, installation commands, and running the project.
  4. Scripts: Information about available npm/yarn scripts for running the app and building it.
  5. Project Structure: A simple breakdown of the file and folder structure within the src/ directory.
  6. Contributing: Guidelines for contributing to the project, including forking the repo and submitting a pull request.
  7. License & Acknowledgements: Project license and credit to tools used in the project.

Contact

Feel free to reach out for any questions or suggestions.

❤️ Built with love by Usama Forayeje.