chingu-voyages / v18-toucans-team-05

Add-project-description-here | Voyage-18 | https://chingu.io/
0 stars 0 forks source link

Chingu Voyage 18 Team Project - Chingu.io

ProjectScreenshot

Toucans 05 Team - Blog App

For Chingu Voyage 18 the Toucans team 05 created a blog application based on Dev.to. This was created over 6-weeks following the Agile Scrum methodology.

Some of the features of this app are:

The app is deployed here.

Getting Started

This project is based on several packages including Gatsby/React, Sass, and GraphQL.

Running Locally

  1. Fork or clone the project from this repo
  2. npm install to download and install packages from package.json
  3. npm run develop to run the app
  4. Once the app has started open the browser using the URL localhost:8000 to use the app

That's all!

Deploying the App

We have chosen to deploy to Netlify.com. However, you may prefer another hosting service. When choosing a site to deploy to make sure it supports Gatsby and React.

Prerequisites

All dependencies are included in the package.json file.

The following environment variables are required to run the app. These should be added to a .env.development file in your local repo for testing and to the hosting service for your Production deployment.

Variable Name Description
API_KEY Private key for the quote
GATSBY_ALGOLIA_APP_ID Application ID for the Algolia search engine
GATSBY_ALGOLIA_SEARCH_KEY Private key for the Algolia search service
ALGOLIA_ADMIN_KEY Administrative private key for the Algolia search service

You can find more information about how to use Algolia in Gatsby here

Authors

License

This project is licensed under the MIT License