Convert your favorite whitewater river into an interactive guide on a centralized database.
Release is right around the corner. This page will be your resource for adding a map to the database.
Node.js is an open source server environment that must be installed prior to running the project.
Git is a free and open source distributed version control that is used to contribute changes.
-
Move into the root directory of the project.
$ cd ./bent-shaft-maps -
Install the server and and the client.
$ npm run full-install -
Run the development environment.
$ npm run dev
The data editing user interface is found at the following address:
http://localhost:3000/form
For optimal workflow, run 2 clients in split screen.
The first is form and the second is the live server to view changes
http://localhost:3000
Changes made in the form will be instantly shown in all open clients.
Use the various inputs to edit data. Click "Submit" or press "Enter" to update changes to database.
Add a river, rapid, or feature.
Add a rapid, or feature.
Once you have made changes to your local repository, it is time to have them reflected on the live site. This is done using a standard "pull request from a fork" workflow. Submit a pull request with title that states the river that was changed, and a description that briefly outlines what changes were made.
Bent Shaft Maps is simply visual database of whitewater maps. It precisely shows the location and size of all waves, holes. and waterfalls in a rapid. It explains how to safely navigate the rapid using visual representations of "lines" through the rapid. It shows eddys of signifigance, and portage locations.
Maps can be added by anyone who knows how to fork a project on Github. Everything is done though our user interface so you will not have to write a single line of code. It's dead easy, I promise!
Here are other ways that you can get involved:
Use the "Submit Info" button on the top left corner of every rapid to streamline river information to our developers. We want to hear any information you have about any rapid on any river.
Check out our GitHub issues, I'm sure you will find something you like. If not, suggest a feature/improvement by creating an issue!
There are hundreds of reasons why I want to hear from you.
- Want to get involved or contribute?
- Suggest a change or a new feature?
- Want your company's logo on a river page?
- Tell us your favorite way to drink a booty beer?
See you on the river 🌊