This project is based on the Node API and Client Boilerplate. With Docker, you can start all the services (Node Express API Mockup Data Boilerplate and Create React App Boilerplate with one bash command.
Download and install the Docker Community Edition.
Executable bash commands have been provided to easily execute Docker commands.
From the root
directory of the project, run the following commands:
Command | Description |
---|---|
bin/install |
Clone the apps, build the Docker containers, and start the apps |
bin/reinstall |
Delete then clone the apps, rebuild the Docker containers, and start the apps |
bin/start |
Start all the services (API and client) |
bin/stop |
Stop all the services |
bin/console <container ID or Name> |
Access the terminal console of the API or client containers |
Note: To manage separate Docker instance for API or client,
open another terminal console and change the project directory from root
to api
or client
and run the commands above.
Command | Description |
---|---|
bin/css/watch |
Watch and compile *.scss files on file changes (for Mac users only) |
bin/css/build |
Manually compile *.scss files |
Note: To run the commands above for separate client Docker instance, simply change the project directory from root
to client
.
Run the bin/install
to clone the API and client apps.
If the installation process is successful, both the API and client services shall be started.
Use the following credentials to test different API responses. Default password for all accounts is password
.
Name | Description | |
---|---|---|
Super Admin User | [email protected] |
Has wildcard access |
Admin User | [email protected] |
Has wildcard access but Admin › Users › Delete is excluded |
Common User | [email protected] |
Can access My Profile , Admin › Dashboard , Users , Users › View, and Settings |
Referrer User | [email protected] |
When redirect is set without the domain, e.i. /admin/dashboard , user shall be redirected to internal page if no location path (referrer) found on the Sign In page |
Redirect User | [email protected] |
When redirect is set with complete URL, e.i. https://github.com/anthub-services , user shall be redirected to external page if no location path (referrer) found on the Sign In page |
Blocked User | [email protected] |
User is signed in but the account is blocked |
Unauthorized User | <any invalid email> |
Simply enter wrong email and/or password |