Getting Started

[JeffThorslund]

Bent Shaft Maps

A visual system for mapping whitewater rivers for use by kayakers, canoeists and rafters.

• Describes lines, eddies, waves, holes, waterfalls, hazards, safety and more.
• Account for changes in river levels.
• Collaborative contribution system allows for crowd sourced map building and review.

Inspiration

There are many websites and apps that provide detailed information on paddling sections of whitewater rapids.

• American Whitewater
• Liquid Lore
• RiverApp
• Whitewater Guidebook

Whitewater rivers are dynamic, and the amount of water that flows down a river drastically changes how it is safely navigated. Using interactive image overlays that change with the water level, detailed rapid information can clearly be explained and shown to users. This allows for more detailed data, and more specific data, allowing a user to be better informed before getting on the river.

Setting up your local environment

1. Install Node.js
2. Fork and Clone the repository.
3. Get a .env file from @JeffThorslund .
4. npm run full-install to install node-modules for both client and server.
5. npm run dev to run a development environment that runs the server, the front end, runs all tests, and watches sass changes.

Contributing

Check out issues with the "First Issues" tag. These will be single, properly explained, and will not require an in depth understanding of the code base. Ask lot's of questions!