be-demo
Table of Contents
Overview
be-demo is a test platform for backend application server libraries,
practices, & techniques.
Application Architecture
This server is built using the following main libraries, services, and tools.
For all others and for current release dependencies please consult the
package.json file.
| Dependency | Description |
|---|---|
| Dotenv | Library for managing .env |
| ExpressJS | Frontend framework |
The following backend services are invoked using a REST API:
| Route | Description |
|---|---|
| wakeup | Wakes up the backend when the first FE page loads |
Installation & Configuration
-
Clone or fork this repo using git. Don't forget that to create a runnable application you'll also need the backend.
-
npm install -
To run the app locally enter
npm run dev -
Open a new browser window and navigate to the URL
http://localhost:3100/wakeup. This assumes that you haven't changed the default port number.
Environment variables
The following environment variables must be set up for the app to run properly:
| Key | Value |
|---|---|
| PORT | <port-number (e.g. '3100')> |
| CLOUDINARY_URL | cloudinary://: |
| CLOUDINARY_NAME | <your 9-character unique cloud name> |
Release History
You can find what changed, when in the release history
License
Copyright 2022
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.