Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jarenmcdonald1/rmdblog-nuxt

RMD Holistic's public website. Built with NuxtJS and Netlify CMS
https://github.com/jarenmcdonald1/rmdblog-nuxt

nuxtjs tailwindcss vue

Last synced: 18 days ago
JSON representation

RMD Holistic's public website. Built with NuxtJS and Netlify CMS

Awesome Lists containing this project

README

        

# Rachel's Blog Site

[![Netlify Status](https://api.netlify.com/api/v1/badges/e6ccaad0-a6a0-491f-afa7-5aca4a74fc09/deploy-status)](https://app.netlify.com/sites/rmdblog-test/deploys)

View live site here: [rmdholistics.com](https://rmdholistics.com/)

### About the site

This is a business site meant to attract potential clients and existing customers to my services. I use the blog to post updates and stories that keep users coming back for more content!

### Improvements

NuxtJS and Vue

### Tools used to develop:

- Adobe Illustrator, Photoshop, XD, Media Encoder
- Nuxt.js
- Vue 2
- PostCSS
- Tailwind
- PurgeCSS
- Dark mode & ColorModePicker
- PWA
- Netlify CMS
- Prettier
- Nuxt-content

## Like what you see?

Developed by Jaren McDonald. Check out my portfolio for more [jaren.ca](https://jaren.ca/) Say hi! [email protected]

## Get Started

1. πŸ“¦ Install dependencies.

```bash
npm install
```

2. πŸ— Run the project for local dev. This will start a hot-reloading server at `localhost:3000`.

```bash
npm run dev
```

3. 🌌 Build the app for server-side rendered deployment. See more about **Universal SSR** in the [Nuxt.js docs](https://nuxtjs.org/guide#server-rendered-universal-ssr-).

```bash
npm run build

# And to serve that deployment...
npm run start
```

4. ⚑️ Generate a fully pre-rendered static site. See more [in the docs](https://nuxtjs.org/guide#static-generated-pre-rendering-).

```bash
npm run generate
```

### Personalize setup

1. Copy and change the .env-file

- `cp .env-example .env`
- Then change the values

2. Change the value on these lines

- `static/admin/config.yml` β€” `site_url` & `logo_url`
- `content/site/info.json` β€” `sitename`, `sitedescription` & `sitelang`
- `package.json` β€” `name`, `description`, `author` & `repository.url`
- `pages/index.vue` β€” The start page of your new website!

3. Change colors, favicon, content & content collections

- Colors are managed in `assets/scss/_vars.scss` & `tailwind.config.js`
- Favicon is generated by [@nuxt/pwa](https://pwa.nuxtjs.org/). You should change the `static/icon.png` to something new, and then match the new filename and source in `nuxt.config.js` under `pwa.icon`. Replace the preview.jpg as well.
- Content is managed mainly in [local Netlify CMS](http://localhost:3000/admin) by going to your `/admin`, in development mode by double-clicking on a post or by hand in `/content`
- Content collections are managed in `static/admin/config.yml`

4. Change font

1. Add/change your font link in `nuxt.config.js` under `head.link`. You can add a `` as `link: [{ rel: 'stylesheet', href: 'font.css' }]`, like [this](https://vue-meta.nuxtjs.org/api/#link)
2. Then append your font name in `tailwind.config.js` under `theme.extend.fontFamily.sans` (or other). Like `sans: ['Inter', ...defaultTheme.fontFamily.sans]`
3. Then if you've uncommented the included netlify plugin "[Subfont](https://github.com/Munter/netlify-plugin-subfont#readme)" in `netlify.toml`, it will automatically post-processes your web page to use an optimal font loading strategy.

## More info

> This project was bootstrapped with `create-nuxt-app`. There are more detailed explanations of how everything works in the [Nuxt.js docs](https://nuxtjs.org).

### Netlify Identity

Make sure to set to "registration invite only" [here](https://app.netlify.com/sites/YOUR_NETLIFY_SITE_SLUG/settings/identity#registration-preferences) if you don't want spam.

When you create your first account, _don’t_ sign up using OAuth, generate a new password and sign in that way locally, otherwise a successful login will send you to the URL you typed in instead of keeping you on localhost.

---

Originally based on [Henry Desroches' nuxt-netlify-cms-starter](https://github.com/xdesro/nuxt-netlify-cms-starter).

---

## Troubleshooting

- > I added a CSS class, but it doesn't show
- It is most likely purged by PurgeCSS, make sure it is whitelisted in `purgeCSS` in `nuxt.config.js`

- > I tried logging into/saving in Netlify CMS, but I can't
- It may be that you haven't [enabled Netlify Identity](https://app.netlify.com/sites/YOUR_NETLIFY_SITE_SLUG/settings/identity) or [setup the Git Gateway](https://app.netlify.com/sites/YOUR_NETLIFY_SITE_SLUG/settings/identity#services) correctly, [check the docs](https://www.netlifycms.org/docs/git-gateway-backend/)

- > "This repository is configured for Git LFS but 'git-lfs' was not found on your path."
- Install git-lfs then run `git lfs install` in project root. Then to download the images, run `git lfs pull`. Or if you don't want to download the files/can't login to the lfs server, run `git lfs install --skip-smudge` instead.

- > I can’t get Git LFS to run correctly on Netlify
- Make sure that you have in your [Netlify build settings](https://app.netlify.com/sites/YOUR_NETLIFY_SITE_SLUG/settings/deploys#environment-variables), set the environment variable `GIT_LFS_ENABLED` : `true`. Then also make sure that Netlify LM is setup as [their docs](https://docs.netlify.com/large-media/setup/) specify.