Getting Started

Cuba React Admin Theme is pure React theme, Yes! you read correct, it's No Jquery React admin theme including all feature and functionality with ease of integration for your project. Cuba theme documentaition will help you to understand React from scratch for making your own perfect real time dream application.

Follow the documentation carefully to solve your issues in minutes. Apart from that if you don't find solution of you problem in here then you can raise a support ticket for your issue atpixelstrap.freshdesk.com

Dependencies Dependencies

  • React 18
  • Bootstrap 5
  • SCSS

This Documentation will guide you through all the concepts used in the theme and hopefully answer all your queries. Below are the things that you are going to find in this documentation.

Folder Structure:

Before starting any project, it is very important to set a folder structure. It helps us organise our code neatly and makes it easier for the future developers to modify anything in the theme.

Make sure that you go through the explaination of folder structure used in our theme, it will become easier for you to make any modifications. If you want , you could follow our folder structure in you project , that way if you encounter any difficulties in your project , you can refer our theme.

Installation Guide:

To make sure that you can setup your project smoothly, we have provided an Installation guide for you to follow. This Installion guide contains everything from installing node till running your project. Do not miss any steps while creating a new project or else you might have to start over again.

Theme Layouts:

With multiple customization options , we can create many different page layouts. Its upto your imagination, how you use the options and implement them in your website. But to give you a starting point, we have used all the available customization options and made a few different layouts. You can use them to get some inspiration for you own website or use them as they are.

Theme Customizer:

To make your theme look unique and as per you taste, we have provided theme customizer, through which you can make changes according to your preference within the theme. And we have also provided a guide on how the customizer works. You can refer it to make your own custom changes.

  1. Layout Types
  2. Sidebar Options
  3. Unlimited Colors
  4. Mixed Layout

To navigate through the website, a sidebar is must. But with increasing page , number of lines required to display all the links in sidebar increases rapidly. To make it shorter we have used looping concepts. You can refer our guide to sidebar to learn more about how our code logic works.

Dark Layout:

It is essential for us to maintain good user experience, and even when they are browsing through your website at night, that experience should not be ruined just because your website is too bright. To make sure our user gets the best experience at any time of the day, we have added the dark mode. Go through our Guide to dark layout to know more about it.

SCSS Structure:

When the theme is this big, there is a vast amount of style written. To organise such amount of code , a proper folder structure becomes necessary. This way it becomes easier for us to find and modify styles of a component without much hassle. You could refer to our explaination on the scss folder structure and use it in your project to keep your styles more managed.

Creating New Page:

When you have completed setting up your project, you might require to add more pages. A short guide on how to create new pages have been given in this documentation. You can refer it and start adding your own pages.

Routing Guide:

One of the most important things in any React site is routing. Without it your website cannot run. It is responsible for creating paths for our website pages and attaching components to show to those paths. An extensive guide has been made on this topic, go through it and follow the given steps to make you own routes.

useContext Hook Guide:

There are multiple elements in this website that are dependent on each other, when the state of one element or component changes then according to that other component might have to change as well. For that we can keep emiting event till we reach the common parent components and pass props through it. But when having multiple levels of parent-child relationship this process becomes very difficult to implement. To tackle this problem useContext Hook has been provided. And this is the most powerful part of our theme. We have not used any third-party packages or libraries for managing the global state. To know more about it refer our useContext Hook Guide.

Loader:

Content of the website takes some time to load when the website is fetching the data from an api or loading a vast amount of styles. This delay can become a reason for user's bad experience with your website. To avoid this we have added a loader. When the content is loading in the background we could just show loader to indicate that our content is still loading. Have a look at our loader guide to see how we have implemented loader logic in our theme.

Multi Language Guide:

We will have many users accross the world, and they will be comfortable reading through your website if the language used is their native language. Multiple languages functionality has been provided so according to the users you can implement options for many different languages.

Components:

A good practise while coding is to Never Repeat Your Code. Which means once you write some lines of code, you should avoid writing same lines of code somewhere else. Make those lines of code in such a way that you can you it multiple times throughout your website. We have created such components and given a detialed explaination about them. Make sure to go throught it.

Apps:

Chat Application , To-Do application, Email ApplicationTo manage admin side functionalities we have created a few different apps like Chat Application , To-Do application, Email Applicationetc... To find out what other applications we have provided , see our Apps Guide.