This repo shows the development state of the website built at ThompsonBoilerWorks.com.
Despite being available on github, this repository is intended as a read-only resource and has been licensed as such. Permissions are not given to use or modify this software.
This section is intended for usage of future developers or upon permissional changes.
After cloning the repo to your local machine enter the root directory and run make install-deps.
Having completed this, in the root directory run make up.
This runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Explained here are the most important points of the code structure, where to find configs, etc.
.
├── backend
│ ├── .gitignore # Files that should not be posted to git (ex. npm modules)
│ ├── Dockerfile # Backend container configs
│ ├── package.json # Backend code dependencies
│ ├── index.js # Main app file starting and handling node server.
│ └── ...
├── frontend
│ ├── public # Static assets that are deployed as-is when built
│ ├── src # Code directory for frontend container
│ │ ├── Assets # Static assets (images, icons)
│ │ ├── Components # Non-page level react components (ex. navbar)
│ │ ├── Pages # React component pages (ex. about, contact)
│ │ ├── Styles # Global styles and SCSS mixins
│ │ ├── Utils # Reusable functions and globals
│ │ ├── Values # Localization data (language translations)
│ │ ├── App.jsx # Main app file composing the entire application
│ │ └── ...
│ ├── .gitignore # Files that should not be posted to git (ex. npm modules)
│ ├── jsconfig.json # Project config (enables absolute path imports)
│ ├── Dockerfile # Frontend container configs
│ ├── package.json # Frontend code dependencies
│ └── ...
├── .eslintrc # Airbnb Eslint configs/rules
├── .prettierrc # Prettier configs/rules
├── docker-compose.yaml # Container runner and configurations
└── ...
Frontend:
Backend:
DevOps:
Linting and Formatting:
This website is currently deployed onto Amazon Web Services by making use of the free plans 750 hours of free EC2 usage.
//more to come
As this code is currently unlicensed, no permissions are given to use or modify this software.