Commit 73ba0f8b authored by Porter Libby's avatar Porter Libby
Browse files

work on docs

parent c0ff2b01
......@@ -8,7 +8,10 @@ Contributors: Porter Libby
[![Website shields.io](https://img.shields.io/website-up-down-green-red/http/shields.io.svg)](http://cluster.earlham.edu:9900/)<br>
**Docs:**
[ [ Database Map ] ](docs/DATABASE.md) [ [ Customization ] ](docs/CUSTOM.md) [ [ Mobile App ] ](docs/CUSTOM.md)
[ [ Database Map ] ](docs/DATABASE.md)
[ [ Developer Guide ] ](docs/DEV.md)
[ [ Customization Guide ] ](docs/CUSTOM.md)
[ [ Mobile App ] ](docs/MOBILE.md)
[ Live Demo Version ](http://cluster.earlham.edu:9900/)
......
# Docs: Developer Guide
[[ Main README ]](../README.md)
## Javascript Files
Server-side JS:
- **index.js** - Main server-side file. Passes routes from queries to client-side.
- **queries.js** - Another server-side file, contains all the servers query routes and templates for getting information from the PSQL database.
The `public/js` folder contains all the client-side JS:
- **public / js / main.js** - contains the `ready()` function which performs setup when `views/index.ejs` loads.
- **public / js / data.js** - contains all the client-side functions for getting data from the PSQL database. Most of these are references to routes which get information on the server side, and then use this information to create additional selectors on the `data` screen, or render content.
- **public / js / graph.js** - handles creation of graphs and tables for the `graph` view of the tool. Uses chartJS.
- **public / js / map.js** - handles creation of maps and points for the `map` view. Uses ARC GIS JS API.
- **public / js / util.js** - handles odd things, such as generation of `HTML` for the template, and disabling/enabling views.
## HTML Template
For style and `CSS` information, refer to the [ customization guide](CUSTOM.md).
HTML template exists in `views/index.ejs`.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment