Git Product home page Git Product logo

twin-cities-aid-distribution-locations's Introduction

Twin Cities Aid Distribution Locations

A webapp to coordinate aid and care in the Twin Cities. https://twin-cities-mutual-aid.org/

About the project

This project is only a few days old, and things are changing very rapidly. We'll do our best to keep this readme up-to-date, but if something doesn't look right, it's probably out of date.

This project is unusual because there are two separate, siloed teams working in tandem:

  • Website team: This team (us) is using a channel within the Open Twin Cities slack to communicate. There's a link at the top of the Open Twin Cities website to join, if you'd like to help out.
  • Data team: The team working on updating the underlying data to ensure the real-time info is up-to-date is partly coordinated via a very large Facebook group called South Minneapolis Mutual Aid Autonomous Zone Coordination. We don't have much more information at this time, but will update this when we do.

Feature requests & feedback

We're using Github Issues to manage tasks, and have a kanban board set up. If you'd like access to the kanban board reach out in the OTC slack channel.

If you've got a feature request or feedback to share on the website, feel free to submit an issue on GH issues, or bring it up in slack.

Data

Data is sourced from a google spreadsheet.

To test locally with your own copy of the spreadsheet, duplicate the example spreadsheet, make your changes, and re-publish it. Then follow the steps https://www.freecodecamp.org/news/cjn-google-sheets-as-json-endpoint to extract the sheet ID out of the url to plug into the DATA_URL const.

const DATA_URL = 'https://spreadsheets.google.com/feeds/list/1XJhbzcT_AubgnqAJRsbOEbMO3HPTybG3yNcX6i-BgH0/1/public/full?alt=json'

Additional documentation

About the application

This started as a very lightweight, single page html file, and we've tried very hard to keep things as simple as possible.

Setup

  1. Install node at the version specified in the .node-version file. If you use a version manager like nodenv or nvm, this should be detected automatically.
  2. Install dependencies with npm
    npm install
    
  3. Configure environment variables
  4. Build and run the application with npm
    npm run dev
    
  5. Visit the application in your browser at http://localhost:8080
  6. Start building!

Environment Variables

The application uses environmental variables to manage configuration between environments. These values are set in a .env file in the project root directory.

To set up a .env, copy the .env.example file, which lists needed configuration values. For example, in the Mac OS terminal:

cp .env.example .env

A set variable in the .env file will look like this:

SNOWPACK_PUBLIC_MAPBOXGL_ACCESS_TOKEN=1234

If you're a member of the Twin Cities Mutual Aid organization you can find the default values for the local development env file here:

https://github.com/Twin-Cities-Mutual-Aid/secrets/blob/master/.env

If not, you can ask for the most recent values of the configuration values from the Open Twin Cities slack #tc-aid-dev channel. They are pinned in the channel.

If you need to introduce a new environmental variable, please coordinate with developers in the #tc-aid-dev channel, add it to the .env.example file, and note it in your pull request.

Run locally

To run a development server that will auto-reload on save, run this command from the project directory:

npm run dev

A server will run on http://localhost:8080

Adding things

Adding A Dependency

  1. Add your dependency with npm install --save <dep>
  2. Use your dependency with import <whatever> from '<dep>'
  3. Run npm run snowpack install to vendor the dependency

Adding Stylesheets

From a dependency

  1. Import the sheet from the dist folder like import '<dep>/dist/stylesheet.css
  2. That's it.

From a new Source file

  1. Create a stylesheet in src/styles
  2. Import the sheet either in the index or from whatever js file the styles apply to.

Adding an Image

Images go in public/images and will be served under <url>/images/image_name.whatever

Any other static file

If you need to add some other kind of static file, it should go somewhere in the public folder.

Code of Conduct

Contributors to the project are expected to follow the Code of Conduct.

twin-cities-aid-distribution-locations's People

Contributors

alexives avatar alyiri avatar andyinabox avatar arich avatar benjifs avatar bergstrg avatar caseyhelbling avatar codarose avatar comeoneileen avatar crhistianramirez avatar cwood821 avatar gabe-bergstrom avatar jasonthibeault avatar jdalt avatar kindrebelg avatar kmarekspartz avatar maxine avatar mc-funk avatar omawhite avatar samanpwbb avatar wbushey avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.