Skip to content

Commit

Permalink
pull readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kikiklang committed May 19, 2021
2 parents f08ce8e + 416c59b commit 2c0c012
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,7 @@ To get a local copy up and running, you will need:
```
3. Still in your terminal, move into pomme-page freshly created folder and run this command to install all project dependencies
```sh
cd pomme-page
npm install
cd pomme-page && npm ci
```
4. To finish the installation, you will have to provide a `.env` file where you can place your configuration variables like API keys. Put this file at the root of pomme-page folder (see example with the `.env.example` file).

Expand Down Expand Up @@ -125,7 +124,7 @@ You can make your theme with the css variables found in `index.css`
Please feel free to contribute if you like this project and have some time to spare.

## Deploying
After the build process, you'll find a `dist` folder that parcel just created. We still have API Keys in the code. In my case, i deploy this behind a caddy reverse proxy and limit/filter access to these static files only from my personal computer IP. At the end, you will load around 45 Kilobytes of html/css/js (15 Kilobytes gzipped) in your browser, which is quite light for a startpage i suppose.
After the build process, you'll find a `dist` folder that parcel just created. We still have API Keys in the code. In my case, i deploy this behind a caddy reverse proxy and limit/filter access to these static files only from my personal computer IP. At the end, you will load around 50 Kilobytes of html/css/js (~20 Kilobytes gzipped) in your browser.
If you plan to deploy your build where it will not be served from your domains root (like github-pages). You must change your parcel build command in the `package.json` file to
```json
"build": "npm run clean && npx parcel build src/index.pug --public-url ./ --no-cache"
Expand Down

0 comments on commit 2c0c012

Please sign in to comment.