This project is based on the
Node API and Client Boilerplate.
Required node version is 9.11.2.
The client app is bootstrapped with Create React App
and Bootstrap 3.3 framework and theme.
Copy .env.dist to .env and change the values of the environment variables if needed.
REACT_APP_SITE_NAME=React App Boilerplate
REACT_APP_API_BASE_URL=http://localhost:7770
REACT_APP_API_SIGN_IN_URL=http://localhost:7770/sign-in
REACT_APP_API_SIGN_OUT_URL=http://localhost:7770/sign-out
REACT_APP_API_VERIFY_TOKEN_URL=http://localhost:7770/verify-token
REACT_APP_API_SESSIONS_URL=http://localhost:7770/sessions
REACT_APP_API_USERS_URL=http://localhost:7770/users
REACT_APP_HASH=sha1hash1.sha1hash2.sha1hash3
NOTE: Generate random hashes and concatenate the hashes with “.”. The same hashes should also be used in the API app. The more hashes, the better.
Copy ./src/Config.dist folder to Config and change the configurations if needed.
yarn
yarn start
Note: See Bash Commands section for Docker.
To generate the ./client/src/Assets/Styles/Style.css,
open another terminal console then on the root directory of the project,
run the following command:
yarn run watch-css
The command above works only in Mac with the fsevents module installed.
Run the command below as an alternative:
yarn run build-css
Note: You must run the command above manually everytime you made changes to .scss files.
All the *.scss files shall be compiled to *.css but only the Style.css is included in the repository.
Access the app at http://localhost:7771.
Download and install the Docker Community Edition.
Note: See Bash Commands section for Docker.
The yarn run watch-css command should be running on a separate terminal console for client app.
On the root directory of the project, run the following commands:
Note: To view the Docker containers, open another terminal console then enter docker ps.
| Command | Description |
|---|---|
bin/install |
Build the Docker container and start the app |
bin/reinstall |
Rebuild the Docker container with the current branch and start the app |
bin/start |
Start the client app service |
bin/stop |
Stop the client app service |
bin/console <container ID or Name> |
Access the terminal console of the container |
| Command | Description |
|---|---|
bin/css/watch |
Watch and compile *.scss files on file changes (for Mac users only) |
bin/css/build |
Manually compile *.scss files |
- Node Express API Mockup Data Boilerplate – non-database API server powered by Express
- Node Express API Boilerplate – API server powered by Express and PostgreSQL database
- Rails API Boilerplate – API server powered by Ruby on Rails and PostgreSQL database
With the Node Express API Mockup Data Boilerplate
or the Node Express API Boilerplate app,
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 |
The following boilerplates can be used to install and run the API and client boilerplates in a Docker container.