senior-dev-1019/admin-dashboard-react

React Admin Dashboard

Quick Start in Docker

Get the code

$ cd react-berry-dashboard

Start the app in Docker

$ docker-compose pull  # download dependencies 
$ docker-compose build # local set up
$ docker-compose up    # start the app 

The React UI starts on port 3000 and expects an API server on port 5000 (saved in configuration).

How to use it

To use the product Node JS (>= 12.x) is required and GIT to clone/download the project from the public repository.

Step 1 - Clone the project

$ git clone https://github.com/senior-developer1019/admin-dashboard-react.git
$ cd admin-dashboard-react

Step 2 - Install dependencies via NPM or yarn

$ npm i
// OR
$ yarn

Step 3 - Start in development mode

$ npm run start 
// OR
$ yarn start

Configure the backend server

The product comes with a usable JWT Authentication flow that provides only the basic requests: login/logout/register.

API Server URL - src/config/constant.js

const config = {
    ...
    API_SERVER: 'http://localhost:5000/api/'  // <-- The magic line
};

API Server Descriptor - POSTMAN Collection

The API Server signature is provided by the Unified API Definition

Node JS API Server

The product is also open-source and is already configured to work with Berry Dashboard Template - product features:

• Typescript / NodeJS / Express Server
• JWT authentication (passport-jwt strategy)
• Persistence: SQLite / TypeORM

Compile the API Server

Step 1 - Clone the project

$ cd api-server-nodejs

Step #2 - Install dependencies via NPM or Yarn

$ npm i
// OR
$ yarn

Step 3 - Run the SQLite migration via TypeORM

$ npm run typeorm migration:run
// OR 
$ yarn typeorm migration:run

Step 4 - Start the API server (development mode)

$ npm run dev
// OR
$ yarn dev

The API server will start using the PORT specified in .env file (default 5000).