Table of Contents
This project consists of five different views. Home is where the application opens up, providing an overview of the project as a whole. Map provides an interactive US map, showing the legal landscape of trans laws in a given state. News has filtered news sources as well as a custom feed generator. Forum provides an anonymous community forum for users to discuss trans issues. Resources is a repository of external resources useful for trans people to know.
Setting up this project is altogether fairly simple.
The only prerequisite is NPM.
- npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/rdziewietin/trans-knowledge
- Install NPM packages
npm install
- Run milestone command
npm run milestone-02
Internally, the src folder contains all the work done on this project, with the client folder being the client-side work (i.e. milestone 2) and the server folder being server-side work (milestone 3).
In client, the media folder contains the only image file used in the project, a US map. Each of the other files make up the code. index.html is the sole HTML file, styles.css is the custom CSS, and main.js is the primary JavaScript file run to provide interactivity. Most of the other .js files are classes, with the exception of map.js, which contains maps and lists used to provide information for the US map.
In server, testData.js contains all of the mock data used for the program, server.js contains the code to run the server, and db.js contains the PouchDB methods.
The docs folder contains milestone-01 information. It does not provide any functionality to TransKnowledge at this time.
Distributed under the MIT License.