BSA-US / world-of-jackson

22 stars 11 forks source link

World of Jackson

World of Jackson is an interactive feature, accessed on its own and from the Dual Power Map, that explores Cooperation Jackson's mission to build a Solidarity Economy in West Jackson, its active projects, immediate challenges & needs, and long-term vision for Jackson, MS, and the broader region.

Project overview

Contributing

Make sure you read the contributor guidelines before you move on. If you're new to open-source or you're still not sure how to start contributing, we now have a beginner's guide.

Setup

Basic setup

  1. Check out the dev branch:
    git checkout dev
  2. Create a new branch:
    git checkout -b feature/my-cool-thing
  3. Install dependencies:
    yarn

Run World of Jackson

yarn dev-remote

This will use the dev API hosted at https://world-of-jackson-git-dev.blacksocialists.now.sh/api

Develop components in isolation

yarn storybook

Develop API endpoints

To make changes to the API, you'll first need to create your own Vercel project:

Additional setup

  1. Configure your Vercel project
    1. Create an account
    2. Create a project
    3. In the general settings, add the following environment variables:
      • Production environment:
        • CONTENTFUL_CONTENT_DELIVERY_API_TOKEN: u2t0rmxih-X9gkSpY_95PZJVa24-ufFSK4iVfPxPDho
        • CONTENTFUL_ENVIRONMENT: master
        • CONTENTFUL_SPACE_ID: 7zzvnrgo4q2e
      • Preview & development environments
        • CONTENTFUL_CONTENT_DELIVERY_API_TOKEN: YxKrxYCp3AdRcB4wRjFS_tIT49DyByCqyogZ-K-kJmE
        • CONTENTFUL_ENVIRONMENT: dev
        • CONTENTFUL_SPACE_ID: 7zzvnrgo4q2e
  2. Configure your local environment
    1. Install now globally:
      yarn global add now
    2. Link your local repo to your Vercel project:
      now
    3. Pull your environment variables:
      now env pull

Run World of Jackson with your local API

now dev