Skip to content

foleyb25/AllThingsGreat-Writer

Repository files navigation

All Things Great Application


Description

All Things Great is a multi-media and content distribution SaaS covering topics ranging from sports, to fitness, to current events.

Application

Currently, the application is going through a complete revamp ranging from the front end, API, and DB Schema. Please stay tuned for the official re-release.

This is one of two front-end applications that communicate with our API. The front end applications consist of a user-side (what the public user engages with) and a writer-side (what a selected authenticated writer interacts with). This is the writer-side application. Writer's are able to read blogs, explore reviews, comment on blogs, and rate blogs.

All Things Great front-end applications are written in VueJS.

Dependencies

All Things Great API

NPM

  • auth0/auth0-vue
  • tailwindcss/line-clamp
  • axios
  • cheerio
  • compressorjs
  • dotenv
  • flowbite
  • fs
  • vue
  • vue-router
  • vitejs/plugin-vue
  • autoprefixer
  • postcss
  • postcss-import
  • tailwindcss
  • vite

How To Run

1. Install Node Js on your machine

Here is a link to the NodeJS installer

Node JS is what we like to call a Runtime Environment so we can run javascript in a place other than a browser.

2. Clone this repository

git clone git@github.com:foleyb25/AllThingsGreat-Writer.git

3. Install npm packages

Change Directory into AllThingsGreat

cd AllThingsGreat-Writer

Install dependencies

npm install

4. Run on your localhost

npm run start:dev

5. Create a .env file

Create the .env file in the root of the repository

touch .env

Copy the following contents into your .env file

VITE_AUTH0_DOMAIN=
VITE_AUTH0_CLIENT_ID=
VITE_AUTH0_CALLBACK_URL=
VITE_AUTH0_AUDIENCE=
VITE_ENV=

You can follow the vueJS Auth0 Guide to determine the VITE_AUTH0... variables above.

The VITE_ENV can be either 'production' or 'development'. If working in a development or sandbox environment use development. If pushing to a live server, use development

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published