2021-01-27 11:53:13 +03:00
|
|
|
**Please note: This app is being developed. There may be bugs, and everything is subject to change.**
|
|
|
|
|
|
|
|
|
|
# App Name @todo
|
|
|
|
|
|
|
|
|
|
Description @todo
|
|
|
|
|
|
|
|
|
|
## Running the site locally
|
|
|
|
|
|
2021-01-27 12:34:41 +03:00
|
|
|
Start by creating a new Firebase project from the [console](https://console.firebase.google.com/) and then setup the Firebase CLI.
|
|
|
|
|
|
|
|
|
|
**Important**: This project uses a local Firebase emulator, which mean you need to install the Firebase CLI globally.
|
|
|
|
|
|
|
|
|
|
npm install -g firebase-tools
|
|
|
|
|
|
|
|
|
|
Clone this repository:
|
2021-01-27 11:53:13 +03:00
|
|
|
|
|
|
|
|
git clone git@github.com:xwp/web-dev-media.git
|
|
|
|
|
|
2021-01-27 12:34:41 +03:00
|
|
|
Go to the project folder:
|
2021-01-27 11:53:13 +03:00
|
|
|
|
2021-01-27 12:34:41 +03:00
|
|
|
cd web-dev-media
|
2021-01-27 11:53:13 +03:00
|
|
|
|
2021-01-27 12:34:41 +03:00
|
|
|
Login to Firebase:
|
2021-01-27 11:53:13 +03:00
|
|
|
|
2021-01-27 12:34:41 +03:00
|
|
|
firebase login
|
|
|
|
|
|
|
|
|
|
Initialize Firebase:
|
|
|
|
|
|
|
|
|
|
firebase init
|
|
|
|
|
|
|
|
|
|
Install the dependencies:
|
|
|
|
|
|
|
|
|
|
npm install
|
|
|
|
|
|
|
|
|
|
Start the Firebase emulator:
|
|
|
|
|
|
|
|
|
|
npm start
|
2021-02-05 18:30:23 +03:00
|
|
|
|
|
|
|
|
## Build process
|
|
|
|
|
|
|
|
|
|
Project uses Rollup to build the main application JS file and the Service Worker file. No transpilation is done, the tooling exists
|
|
|
|
|
mostly just to resolve ES Modules in the Service Worker context. Usage:
|
|
|
|
|
|
|
|
|
|
* `npm run build`: Build the `/public/js/index.js` and `/public/sw.js` files.
|
|
|
|
|
* `npm run watch`: Watch for changes to files in `/src` and rebuild files as necessary on the fly.
|
