Git Product home page Git Product logo

filter-template's Introduction

Finda

You have data with locations. Share it with the world.

Finda is not ready for use yet. This documentation describes the state to which we aspire, and towards which we are developing.

Developers:

  1. This app reads in data.geojson (provided by the end user) and config.json (customized by the end user).
  2. It's all client-side Javascript with a single page for the entire app, so non-developers can deploy quickly.
  3. Keep everything human-readable.

Why use Finda?

  1. You have data with addresses / locations.
  2. You want to put it online.
  3. You want people to be able to search data and find the services they need near them.

I want to use this app for my data set.

Great! Let's get started.

Set up your computer

Mac or Linux
  1. Open the Terminal application.

  2. Make sure the command-line tool Git is installed by entering which git into Terminal. If the command returns a filepath, you're all set. (If Git is not installed, install it.)

Windows

Copy the code to your computer.

  1. Navigate to the folder you'd like to copy the code to by using the cd command.

  2. Clone the repository (i.e. copy the code) from where it's hosted online. Do this by entering git clone [email protected]:codeforboston/filter-template.git

  3. Open the folder you just downloaded using your favorite text editor. (We use Sublime Text.)

Add your data.

Finda requires that your data is in GeoJSON format, since it's an open, web-friendly format.

If your data is not in GeoJSON format, you might try converting it using Ogre. We haven't used it ourselves, but it seems worth a try. We'll recommend an option we've tested in the future.

Configure the application.

To configure the Finda app to display your data, fill in the configuration file.

There are example applications in the examples folder to demonstrate how you might configure your application. Play around with it, and open the 'index.html' file in each example in your browser to see how it looks.

TODO: Finish this section.

Style the application.

You can edit the display of your application using style.css in the styles directory.

TODO: Finish this section.

Host it.

Your Finda application is working on your local computer, but it's not online yet.

If you already have a hosting service, you can use their upload manager or an FTP client to upload the files to your hosting service.

If you do not have a hosting service, find and subscribe to one. FatCow is pretty okay. Please don't use GoDaddy.

Once you have a service, upload all of the files to the root folder (sometimes referred to as just '/'), or upload the entire folder (you can delete the examples folder first) to the host and configure your domain name to point to that folder.

filter-template's People

Contributors

ohnorobo avatar stillwellmedia avatar

Watchers

James Cloos avatar John Moon avatar  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.