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:
- This app reads in data.geojson (provided by the end user) and config.json (customized by the end user).
- It's all client-side Javascript with a single page for the entire app, so non-developers can deploy quickly.
- Keep everything human-readable.
- You have data with addresses / locations.
- You want to put it online.
- You want people to be able to search data and find the services they need near them.
Great! Let's get started.
-
Open the Terminal application.
-
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.)
-
Navigate to the folder you'd like to copy the code to by using the cd command.
-
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
-
Open the folder you just downloaded using your favorite text editor. (We use Sublime Text.)
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.
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.
You can edit the display of your application using style.css
in the styles
directory.
TODO: Finish this section.
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.