If you have any questions that are beyond the scope of this documentation, please feel free to email or contact us via my page.
This guide will walk you through the installation process and prerequisites to get your admin dashboard up and running smoothly.
npm install -g gulp-cli
Follow these simple steps to install and set up Fadmin Admin Template:
Step 1: Unzip
Unzip The Downloaded Folder and open it in vscode or any other code editor you use.
Step 2: Navigate to the Project Directory
Run the command cd ./Admin
in the Terminal
Step 3: Install Dependencies
Run the following command to install the project dependencies:
npm install
Step 4: Build Assets
Run the following command to build the assets. It will create public dir and copy all required assets like js, css and images.
gulp
Step 5: Configure Environment Variables
Create .env file in root dir and initialize all variables as given in sample.env file.
Step 6: Run Project
Run following command in the terminal and enjoy development with Fadmin.
npm run start
Visit http://localhost:8000
in your browser to view your Fadmin Admin Template.
I have tried my best to have standards and modular structure while developing the theme. Following sections are explaining the theme File & Folder, structure, ejs file struture and plugins.
I have tried to follow the standards and modular structure while developing the theme. Let's take a look at the package structure:
Fadmin - Nodejs admin and dashboard. | ├── Admin/ ├── controllers/ │ └── AuthController.js -> Authentication functions │ ├── models/ │ └── UserModel.js -> User Schema file │ ├── routes/ │ └── routes.js -> All Routes Defined here │ ├── src/ │ ├── assets/ │ ├── css/ │ │ └── All css files │ ├── fonts/ │ │ └── All font files │ ├── images/ │ │ └── All images files │ ├── js/ │ │ └── All javascript files │ └── scss/ │ └── All scss files │ ├── views/ │ ├── auth/ │ └── Authentication pages │ ├── layouts/ │ └── Layouts pages │ ├── partials/ │ └── Common component pages │ └── [*].ejs │ └── All ejs page | ├── app.js/ │ └── main file | ├── config.env/ │ └── store environment-specific database passwords. | ├── gulpfile.js/ │ └── customize Gulp tasks as needed. | ├── package.json │ └── Node Package Manager File. | ├── StarterKit/ └── As same folder structure with blank pages. └── Documentation/ └── index.html - documentation file for documentation.
We have used ejs files.
<%- include ('../partials/main') %>
<head>
<%- include ('../partials/title-meta') %>
<%- HeaderCss %>
<%- include ('../partials/head-css') %>
</head>
<body>
<%- include ('../partials/menu') %>
<div class="page-content">
<div class="page-inner">
<div class="container-fluid" id="main-wrapper">
<%- body%>
</div>
</div>
<%- include ('../partials/footer') %>
<%- include ('../partials/right-sidebar') %>
</div><!-- end main content-->
<%- include ('../partials/vendor-scripts') %>
<%- FooterJs %>
<!-- Custom js -->
<script src="/assets/js/custom.js">
</body>
</html>
Files are explained below:
File | Description |
---|---|
bootstrap.min.css
|
Fadmin uses the bootstrap v5.3.2. The core bootstrap file is being used in all the pages. |
style.css
|
This file is containing all common styles for all the pages. |
Install Live Sass Compiler extention in your Visual Code Editor. Click the Watch Sass button at the right side footer of visual studio code.
Files are explained below:
File | Description |
---|---|
.env
|
You have to create this file according to given sample.env file. |
index.js
|
This is the main server file or entry point. |
gulp.js
|
This is a gulp config file. It contains all the gulp configurations. |
routes.js
|
This is a main routing js file for theme and layouts. It contains all the routes configurations. |
custom.js
|
This is a main js file. It contains the custom JS code needed for features including layout, sidebar, etc. |
I've used the following resources as listed. These are some awesome creation and I am really thankful to the respective community.
File | Source / Link |
---|---|
Express
|
expressjs v4.18.2 |
Ejs
|
ejs v3.1.9 |
JWT
|
jsonwebtoken v9.0.0 |
Bcryptjs
|
bcryptjs v2.4.3 |
Bootstrap
|
bootstrap v5.3.2 |
Jquery
|
jquery v3.6.3 |
Simplebar
|
simplebar v6.2.5 |
Materialdesign Icons
|
materialdesignicons v7.4.47 |
Ionic Icons
|
ionicons v7.1.0 |
Font Awesome
|
fontawesome v6.5.1 |
Feathericons
|
feathericons v4.29.0 |
Themify Icons
|
themify-icons |
Typicons
|
typicons v2.1.2 |
Drip icons
|
dripicons v2 |
Apex Chart
|
apexcharts |
Echarts
|
echartsjs v4.0 |
Once again thank you for purchasing the theme. I am always avaialble to help you. If you have any suggestion or feature to make it more better, I am requesting you to contact me, I'll try my best to add them in future updates.
Best,
Version 1.0.0 - 08 February 2024
2019 - 2024 © Fadmin.