The BikeBus app is software meant to be an one-stop shop for all things related to bicycling in a group. This app should be able to create BikeBus routes, events, and groups. It should also be able to send push notifications to users and allow users to send messages to each other. The app should also be able to show a map of the route and allow users to see the route and the BikeBus group in real time.
- BikeBus
BikeBus is a term to describe a group of cyclists that is usually guided by a leader. In the US, this has become a growing activity to help children get to school. This app will help BikeBus leaders create a route, invite new members and allow parents to monitor the BikeBus as it makes it way to school.
This project has always and will be without ads or selling of user data with PII. Anonymous users and anonymized data wherever possible. BikeBus data might be made available to future API to help build safer streets.
The BikeBus User Interface is being developed in the open and we welcome contributions. We are using the GPL-3.0 License. Please see the LICENSE file for more details.
The BikeBus Database (Firebase) is closed and we are not accepting contributions to it at this time. The plan is to safely build a public and private API to access anonymized data in the future.
Other project documentation that is not in this ReadMe are:
- GitHub Discussions
- GitHub Project Roadmap
- GitHub Issues
- GitHub Pull Requests
- GitHub Wiki
- Google Drive Folder
- Code of Conduct
- Security
- License
- Privacy Policy
- Terms of Service
We are using the Ionic Framework to build the app. We are using Firebase for the backend. We are using Google Maps for the mapping and directions. We are using Firebase Hosting for the web app and Firebase Cloud Messaging for the push notifications.
We are a group of volunteers who are passionate about cycling and safe streets.
Please see the Contributors file for more details.
We think technology could help make this a smoother, more fun experience while promoting cycling and safer streets with data for policy makers on street design.
- Create a route, make it a scheduled route and call that a BikeBus group. Invite other or new users to join.
- Map search then allow options to get directions, look for routes or BikeBus groups
- "Bulletin Boards" allow users in a BikeBus or Organization to send messages
- Account page allows users to see their details and change them
How you can help:
- Test the Production app and report bugs
- Suggestions for new features should be added to the Discussions Page page
- Feedback on the UI/UX is always welcome
We are looking for help with the following:
- UI/UX Design
- Ironing out bugs
- Adding new features
- Testing
- Documentation
- Translations
- Accessibility
- Security
- Performance
- npm 18.20.0
We're using Ionic Framework with React to build the app so be sure to check out their documentation.
To get started, open a terminal and navigate to the directory where you want to store the project and run the following commands:
git clone git@github.com:craigm26/bike-bus.git
cd bike-bus
npm installThis will clone the project, navigate to its directory and install all dependencies.
Next, you will need to create a Firebase project + register an app and add the configuration to an env file. This is just to satisfy the Firebase SDK requirements; feel free to decline analytics, A/B testing, etc.
For your convenience, a .env.example file has been provided with the necessary keys and empty values. The following command will create a .env file for you:
cp .env.example .envFrom there, use the values from your Firebase project to populate the .env file as they belong in the firebaseConfig object in src/firebaseConfig.js.
Then, open the .env file and add your Firebase configuration. You can find this in the Firebase Console under Project Settings > General > Your apps > SDK setup and configuration > Config.
With your environment configured, you should be able to run the following commands:
npx ionic servenpx is not necessary if you have Ionic installed globally but generally that is not recommended. This will start a local development server and open the app in your default web browser. You should now be able to see the app running locally! A Google Maps key will be required to see the map. You can get one from the Google Cloud Console but this is probably out of scope for "Getting Started".
Once you have the app running locally, pick an issue from the Issues list or create a new one. Then create a branch and start working on the issue. Once you are done, create a pull request and assign a reviewer.
The reviewer will check the code and merge it into the main branch then deploy the app to Firebase Hosting for testing.
Once the app is tested, the reviewer will deploy the app to Firebase Hosting for production.
- ionic build
- npx cap sync
- npx sync ios
- manually add the GoogleService-Info.plist file to the ios/App folder
- manually modify the config.xml file to add the following lines:
<?xml version='1.0' encoding='utf-8'?>
<widget version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
<access origin="*" />
<platform name="ios">
<resource-file src="GoogleService-Info.plist" />
</platform>
</widget>- Open Xcode and select the project
- Select the target
- Select the "Signing & Capabilities" tab
- Select the "All" tab
- Select the "Signing" section
- Select the "Team" dropdown and select the team
- Select the "Signing Certificate" dropdown and select the certificate
- Select the "Provisioning Profile" dropdown and select the profile
- Select the "Product" menu
- Select the "Archive" option
- Select the "Distribute App" option
- Select the "App Store Connect" option
- Select the "Next" button
- Select the "Upload" button
- Select the "Next" button
- Select the "Done" button
- Go to App Store Connect
- Select the "TestFlight" tab
- Select the "Builds" tab
- Select the build
- Select the group for testing the build
- Open Android Studio
- Select the project
- Select the "Build" menu
- Select the "Build Bundle(s) / APK(s)" option
- Select the "Build APK(s)" option
- Select the "Locate" button
- Drag the .apk file to the Google Play Console
- Select the "Create Release" button
- Select the "Review" button
- Select the "Start Rollout" button
- Select the "Confirm" button
- ionic build
- npx cap sync
- npx sync ios
- npx sync android
- firebase hosting:channel:deploy preview
Production builds will be compiled by Craig Merry and pushed out when tested.
- ionic build --prod
- npx cap sync
- npx sync ios
- npx sync android
- firebase deploy --only hosting:production
- ionic build
- npx cap sync
- npx sync Android
- manually add the google-services.json file to the android/app folder
- clean build in Android Studio
- perform a build in Android Studio - .aab file
- upload to Google Play Store as a new release (production for now)
- ionic build
- npx cap sync
- npx sync ios
- manually add the GoogleService-Info.plist file to the ios/App folder
- manually modify the config.xml file to add the following lines:
<?xml version='1.0' encoding='utf-8'?>
<widget version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
<access origin="*" />
<platform name="ios">
<resource-file src="GoogleService-Info.plist" />
</platform>
</widget>
- commit to github
- Craig Merry - Initial work - craigm26
- Contributors