- You need
Node.js
(at least 10.x version) installed on your machine, if you don't have it, you should install it - download link or just simply runconda install -c conda-forge nodejs
- Install necessary dependencies:
- Run
npm install
on the project root - You can easily check if npm is installed by running
npm --version
- Run
-
For starting the application, the following script (defined in
package.json
underscripts
) must be called:- Please run
npm run start
ornpm run dev
for starting the development environment, which has livereload enabled; - When the terminal is like this
It means you can go to the next step which is:
- Open up the browser (Chrome, Firefox, Safari, etc.) and write localhost:8000 as you can see an example here.
- Please run
-
When you are done please press
Ctrl + c
to end the work in the terminal.
In order to see the available features cd
into features
folder, and you will then find a folder for each of the available features, mostly each folder containing:
- A
routes.js
file that usually contains theGET
andPOST
requests
All feature routes are mounted in routes/index.js
from the project root.
- You can find all the templates in
views
folder where you will find:
- The
layout.ejs
file, the main template layout. - A
pages
folder with all the page templates - A
partials
folder with the common components (header, footer, sidebar)
├── CHANGELOG.md
├── ISSUES_TEMPLATE.md
├── LICENSE.md
├── README.md
├── app.js
├── bin
│ └── www
├── config
│ └── index.js
├── db
│ ├── index.js
│ ├── knexfile.js
│ ├── migrations
│ │ └── 20190213122702_create-users-table.js
│ └── seeds
│ └── create-default-user.js
├── docker-compose.yml
├── docs
│ └── documentation.html
├── ecosystem.config.js
├── env-files
│ ├── development.env
│ └── production.env
├── features
│ ├── login
│ │ ├── commands
│ │ │ ├── load-page.js
│ │ │ ├── login.js
│ │ │ ├── redirect-to-dashboard.js
│ │ │ └── verify-request-body.js
│ │ ├── constants.js
│ │ ├── init-auth-middleware.js
│ │ ├── repository.js
│ │ └── routes.js
│ ├── logout
│ │ ├── commands
│ │ │ └── logout.js
│ │ └── routes.js
│ ├── profile
│ │ ├── commands
│ │ │ ├── load-page.js
│ │ │ ├── update-user-info.js
│ │ │ └── verify-request-body.js
│ │ ├── constants.js
│ │ ├── repository.js
│ │ └── routes.js
│ ├── register
│ │ ├── commands
│ │ │ ├── create-user.js
│ │ │ ├── load-page.js
│ │ │ └── verify-request-body.js
│ │ ├── constants.js
│ │ ├── repository.js
│ │ └── routes.js
│ └── reset-password
│ ├── commands
│ │ └── load-page.js
│ └── routes.js
├── gulpfile.js
├── haproxy.cfg
├── logger.js
├── package.json
├── public
│ ├── css
│ │ ├── argon.css
│ │ └── argon.min.css
│ ├── fonts
│ │ └── nucleo
│ ├── img
│ │ ├── brand
│ │ ├── icons
│ │ └── theme
│ ├── js
│ │ ├── argon.js
│ │ └── argon.min.js
│ ├── scss
│ │ ├── argon.scss
│ │ ├── bootstrap
│ │ ├── core
│ │ └── custom
│ └── vendor
├── routes
│ └── index.js
├── screens
│ ├── Dashboard.png
│ ├── Login.png
│ ├── Profile.png
│ └── Users.png
├── views
│ ├── layout.ejs
│ ├── pages
│ │ ├── 404.ejs
│ │ ├── dashboard.ejs
│ │ ├── icons.ejs
│ │ ├── login.ejs
│ │ ├── maps.ejs
│ │ ├── profile.ejs
│ │ ├── register.ejs
│ │ ├── reset-password.ejs
│ │ └── tables.ejs
│ └── partials
│ ├── auth
│ │ ├── footer.ejs
│ │ ├── header.ejs
│ │ └── navbar.ejs
│ ├── dropdown.ejs
│ ├── footer.ejs
│ ├── header.ejs
│ ├── navbar.ejs
│ └── sidebar.ejs
└