emdecr / the-swell-space

the swell space

The place to document things when the curiosity itch strikes.

Intro | Installation | Local Setup | Server Setup | Credits

Intro

This is a hybrid environment using WordPress to manage content, and Nuxt.js to serve a front-end application.

Installation

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer.

Local Setup

# Clone this repository
## You can use the repo name as the dir name
$ git clone https://github.com/emdecr/the-swell-space

## OR Use whatever dir name
$ mkdir [insert dir name here]
$ cd [insert dir name here]
$ git clone https://github.com/emdecr/the-swell-space .

WordPress

# Go into the repository and the cms dir
$ cd the-swell-space/cms

# Make a wordpress dir
$ mkdir wordpress

# Clone WP in wordpress dir
$ cd wordpress
$ git clone https://github.com/WordPress/WordPress .

# Create a working branch from the right release
$ git checkout tags/5.2.2
$ git checkout -b stable-5.2.2

Installed Plugins

• Meta Box
• Meta Box - CPT
• Meta Box Group
• Meta Box REST API
• TinyMCE Advanced
  • Because sometimes the paragraph tags get stripped in WYSIWYGs

Nuxt

# Go into the repository and the app dir
$ cd the-swell-space/app

# Install dependencies
$ npm install

# create an .env file
$ touch .env
## There should be variables BASE_ROUTER and WP_API_URL
## Ask THE SQUAD (♥︎) for the values

# Run the app
$ npm run dev

Extra NPM Packages

• cross-env
• dotenv
• Google Analytics module for Nuxt.js

Installed Plugins

• Animate on Scroll

Default head entries and modules in nuxt.config.js

Note: Change the keys or project IDs

• n/a

Pre-processors

Need to SASS? Check the official Nuxt.js docs. There's a base SASS setup in the assets dir, but just delete it if you don't need it.

Server Setup

Link to docs coming soon.

Credits

Badges in this README.md provided by shields.io.