Skip to content

Anant/PlanetCassandra

Repository files navigation

PlanetCassandra.org

This project is built using Gatsby. It uses Algolia for content indexing, with separate environments for development and production linked to Airtable and two WordPress instances. If you are interested in contributing to this project, please go to PlanetCassandra's Contribute Page and send us a message. You can also drop into the website-help channel on the PlanetCassandra Discord server and ask how you can help.

Prerequisites

You need to have the following installed on your machine before following the instructions below:

  • Node.js and npm
  • Gatsby CLI

Getting Started

  1. Clone this repository to your local machine.
git clone https://github.com/your_username/your_repository.git
  1. Install the project dependencies.
cd your_repository
npm install
  1. Create a .env file at the root of your project and add the environment variables mentioned below. Remember, the development and production environments have separate variables.
ALGOLIA_APP_ID=
ALGOLIA_API_KEY=
ALGOLIA_ADMIN_KEY=
WP_GRAPHQL=
WP_GRAPHQL_DEV=
GA_TRACKING_ID=
AIRTABLE_BASE=
AIRTABLE_KEY_1=
AIRTABLE_KEY_2=
YOUTUBE_API_KEY=
LEAVES_URL=
EVENTS_URL=
BLOG_POSTS_AIRTABLE_FORM=
USE_CASES_AIRTABLE_FORM=
RESOURCES_AIRTABLE_FORM=

Fill in the correct values for each variable. Never share your private keys or add them to the public repository.

Development

Start the development server.

gatsby develop

or

npm run develop

Your site is now running at http://localhost:8000.

Build

Before building, ensure Algolia has indexed the content. Then, run the following command to create a production build of your site. This will index the data in algolia

gatsby build

Deployment

This will create a static version of your website in the public folder in the root directory of your application. This can be deployed using various hosting options like Netlify, Vercel, GitHub pages, etc.

Remember, it's important to keep your environment variables secure and update them according to your current development or production environment.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.