novoland-developer-networks/OfficialSite
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README and Boilerplate occurrences

Browse Source 
Changed "Configuration" section to instruct developers on what occurrences to rename throughout the package.
This commit is contained in:
Chauncey McAskill
2021-09-18 01:14:34 -04:00
parent 7e30939b14
commit 7e8a21f698
6 changed files with 26 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -31,7 +31,24 @@ npm start
## Configuration ## Configuration
Rename occurrences of `locomotive-boilerplate` with your project's name in `loconfig.json`. There are a few occurrences that should be renamed for your project:
* [package.json](package.json):
* Package name: `@locomotivemtl/boilerplate`
* Package title: `Locomotive Boilerplate`
* [package-lock.json](package-lock.json):
* Package name: `@locomotivemtl/boilerplate`
* [loconfig.json](loconfig.json):
* Browser Sync proxy URL: `locomotive-boilerplate.test`
Remove `paths.url` to use Browser Sync's built-in server which uses `paths.dest`.
* View path: `./views/boilerplate/template`
* [environment.js](assets/scripts/utils/environment.js):
* Application name: `Boilerplate`
* [site.webmanifest](www/site.webmanifest):
* Manifest name: `Locomotive Boilerplate`
* Manifest short name: `Boilerplate`
* HTML files:
* Page title: `Locomotive Boilerplate`
## Build ## Build

2
www/assets/emails/index.html
View File

@@ -2,7 +2,7 @@
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Boilerplate</title> <title>Email | Locomotive Boilerplate</title>
</head> </head>
<body leftmargin="0" marginwidth="0" topmargin="0" marginheight="0" offset="0"> <body leftmargin="0" marginwidth="0" topmargin="0" marginheight="0" offset="0">
<center> <center>

4
www/form.html
View File

@@ -2,7 +2,7 @@
<html class="is-loading" lang="en" data-page="page"> <html class="is-loading" lang="en" data-page="page">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>Form | Boilerplate</title> <title>Form | Locomotive Boilerplate</title>
<meta name="description" content=""> <meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
@@ -20,7 +20,7 @@
<div data-load-container> <div data-load-container>
<div class="o-scroll" data-module-scroll="main"> <div class="o-scroll" data-module-scroll="main">
<header data-scroll-section> <header data-scroll-section>
<a href="/"><h1>Boilerplate</h1></a> <a href="/"><h1>Locomotive Boilerplate</h1></a>
<nav> <nav>
<ul> <ul>
<li><a href="images.html">Images</a></li> <li><a href="images.html">Images</a></li>

4
www/images.html
View File

@@ -2,7 +2,7 @@
<html class="is-loading" lang="en" data-page="home"> <html class="is-loading" lang="en" data-page="home">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>Images | Boilerplate</title> <title>Images | Locomotive Boilerplate</title>
<meta name="description" content=""> <meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
@@ -20,7 +20,7 @@
<div data-load-container> <div data-load-container>
<div class="o-scroll" data-module-scroll="main"> <div class="o-scroll" data-module-scroll="main">
<header data-scroll-section> <header data-scroll-section>
<a href="/"><h1>Boilerplate</h1></a> <a href="/"><h1>Locomotive Boilerplate</h1></a>
<nav> <nav>
<ul> <ul>
<li><a href="images.html">Images</a></li> <li><a href="images.html">Images</a></li>

4
www/index.html
View File

@@ -3,7 +3,7 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>Boilerplate</title> <title>Locomotive Boilerplate</title>
<meta name="description" content=""> <meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
@@ -38,7 +38,7 @@
<div class="o-scroll" data-module-scroll="main"> <div class="o-scroll" data-module-scroll="main">
<header data-scroll-section> <header data-scroll-section>
<a href="/"> <a href="/">
<h1>Boilerplate</h1> <h1>Locomotive Boilerplate</h1>
</a> </a>
<nav> <nav>
<ul> <ul>

2
www/site.webmanifest
View File

@@ -1,5 +1,5 @@
{ {
"name": "Boilerplate", "name": "Locomotive Boilerplate",
"short_name": "Boilerplate", "short_name": "Boilerplate",
"icons": [ "icons": [
{ {