Boilerplate for teaching with React

If you're teaching React, having a local API is useful, but you don't want to go through the trouble of setting up a server. This project is pre-configured with json-server for that purpose.

The setup is minimal, with a webpack config for building the React app and serving it with json-server. db.json can be populated with data and that can be reached via localhost:3030/api/* from the React app.

There are a handful of scripts in package.json and that is enough to build and run the local server for development.

There is no HMR or LiveReload, by design. I just need a simple setup.

If you have something to add that is useful to many people and keeps this simple, I'm happy to accept contributions.

Starting a new project

1. Clone this repository with git clone [email protected]:avanslaars/react-training-boilerplate.git
2. Remove the .git directory with rm -rf .git from the project root
3. Add your own git history with git init and then you can associate your own remote with git remote add origin <remote url>

Included scripts

• build - runs webpack which results in a build to the ./build directory
• watch - runs webpack with the --watch flag
• serve - runs json-server using db.json
• dev - runs both watch and serve for development

Development with Docker

With docker installed, you can simply run docker-compose up.

Alternatively, you can run it with: docker-compose run --service-ports --rm app which will do a one-off run, mapping the ports and deleting the container when you exit it.

This will build and run the image for this application. It will mount the root volume of this project, start the json-server, and start webpack in watch mode to build the client files.

Access the application in a browser through port 4200 (mapping can be changed in docker-compose.yml)