web-app-in-a-box

What is it?

This is essentially a Web App in a box, front and back end, built with the magic of Docker 🐳

We have an ExpressJS Web API, using MySQL for it's data store.

See a Live Demo of the Test API Here!

The front end is React based and there is also a pre-configured phpMyAdmin instance to compliment the setup, all running in an isolated environment in the root of the project!

What does it do?

Whatever you want it to do really, the idea is, it's a simple, easy and fast full stack javascript web app in a box, front end, back end and DB included!

No mucking around! 🎉

TOC

• TLDR
• What is it?
• What does it do?
• Quick Start Usage
  • Create a .env config
  • Run the solution using Docker 🐳
  • What now?
• Development Info
  • Running the solutions standalone
  • Running the entire system
  • Backing up your database
• Project To Dos & Dones

TLDR;

1. git clone [email protected]:YenHub/web-app-in-a-box.git
2. Create your .env config (how do)
3. docker-compose up --build -d && chrome http://localhost/TestAPI

Quick Start Usage

Create a .env config

Create a file at ./api/.env and populate the contents like so, setting a password of your choosing:-

This file is .gitignored

DB_PORT=3306
DB_USERNAME=root
DB_PASSWORD=some_wi1d-pa$$word
DB_DATABASE=nodeDB
DB_HOST=react-express-mysql

Run the solution using Docker 🐳

Run this solution using Docker, WSL2 and your distro of preference.

# Start the solution (-d for detached mode)
docker-compose up

# Stop the solution (Ctrl+C)
docker-compose down

What now?

The api is hosted on port 9000, the front end on port 80

This can be customized via env variables, but those are the defaults.

Once you have the solution up and running, simply visit http://localhost/TestAPI to check it's working correctly, and begin developing the API and Front End.

Development Info

Running FE standalone

The React front end is happy to run standalone from it's root ./client.

# From the root of ./client
npm start

NOTE: The project will be available at http://localhost:3000/ when running standalone

Running API standalone

UPDATE: Following the latest updates, you can now work on the API standalone

# From the root of the project
docker-compose up node-sql

# From the root of ./api
npm run dev

You can now access the API on http://localhost:9000

Running the front or back end standalone:

# Start Front End Dev Server Only
cd client && npm start

# Start Back End Dev Server Only
cd api && npm run dev

Docker: Running the full solution

# Ensure you have docker installed & running
# It's recommended to use WSL2 with Ubuntu LTS

# Run the solution
docker-compose up

# Launch docker container (-d: detached)
docker-compose up -d

# Kill the solution
docker-compose down

# Build the containers
docker-compose build

# Recreate the solution & run
docker-compose up --build --force-recreate

# We can then also do (due to docker-componse `container_name: node-mysql`)
docker start react-express-mysql

# Exec commands in the container:
docker exec -it [container_name] mysql -uroot -p

Backing up your database

The database is defined in ./docker-compose.yml

The MySQL instance is volume bound to: ./docker-volumes and is also in .gitignore

Project To Dos & Dones

• Make it better
  • In progress... forever™
• Dockerize Solution
  • Isolate Networks
    • api-network
    • app-network
  • Front End
    • React
      • http://localhost
  • Backend End
    • MySQL
      • http://localhost:3306
    • phpMyAdmin
      • http://localhost:8080
    • API
      • http://localhost:9000
• Front End
  • Views
    • TestAPI
      • http://localhost/TestAPI
    • User Admin
      • http://localhost/Admin/Users
  • Gubbins
    • Redux
    • TypeScript
    • Jest tests
    • Auth
      • JWT
      • Basic User management
        • View
        • Edit / Delete
• Back End
  • Endpoints
    • API Status Test
      • http://localhost:9000/testAPI/
      • http://localhost:9000/testAPI/payload
    • User Controllers CRUD
  • Auth
    • JWT
    • Basic User management CRUD
      • Roles
      • Permissions

FAQs

Localhost keeps redirecting to https://

This can be annoying, simply visit chrome://net-internals#hsts and delete "localhost" by entering it into the delete field at the bottom