CycleRoute

Table of Contents

• Description
• Visit CycleRoute
• Technologies Used
• APIs
• Installation
• Testing
• Future Development
• Notes

---

Description:

CycleRoute is a full stack web application designed for both cycling enthusiasts and casual cyclists. With CycleRoute, users can easily map the most efficient cycling route to reach their desired destination. Whether you're commuting to work, exploring a new city, or planning a leisurely ride, CycleRoute provides the tools you need to make your cycling experience enjoyable and convenient.

---

Visit CycleRoute:

To test out this page, please follow the link: https://server-i4nt.onrender.com .

• Test User: [email protected]
• Password: Testing532@

This web application utilizes Auth0 credentials and Google APIs, required to run properly.

---

Technologies Used:

HTML	CSS	JavaScript	Express
React	Node JS	postgreSQL	emailJS

---

APIs Used:

• Google APIs:
  • Maps JavaScript
  • Distance Matrix
  • Places
• CityBikes API

---

Installation:

1. Clone the repo:

   git clone https://github.com/xocaid/CycleRoute.git

2. Remove from author's git:

   rm -rf .git

3. Install all NPM packages using this in the root directory:

   npm install

4. Copy the root example environment file:

   cp .env.example .env

5. Restore DB dump file (with password):

   psql -U postgres -f db.sql

   OR Restore DB dump file (without password):

   psql -f db.sql

6. Start the app and view it at http://localhost:3000 by using:

   npm start

---

Testing:

To run tests on terminal, go to client side and run command:

npm test

---

Future Development:

1. Step-By-Step Directions: Provide users detailed directions, making their journeys even more convenient and straightforward.
2. Render Map and Route on Favorites Tab: Implement a feature to display users favorite routes directly on the Favorites tab, allowing for a quick overview of the cycling paths.
3. Save & Locate Favorite Bike Stations: Introduce the capability for users to save and locate their preferred bike stations, providing a personalized experience that allows them to mark and store frequently visited or useful bike stations.
4. More Robust Unit Tests and Edge Cases: Enhance application reliability and user experience by implementing comprehensive unit tests covering various scenarios and edge cases, including handling unavailable bike routes and overseas destinations, ensuring seamless functionality and early issue identification for increased stability.

---

Notes:

Bug with Refreshing Favorites Tab Edits on Hosting Site
Currently, there is a bug that prevents the automatic refresh of notes on the Favorites tab when edited by users on the hosting site. This issue leads to an error in displaying the updated content. To view the latest updates to your notes, please follow these steps:

1. Navigate back to the hosting site by clicking the following link: Render.
2. Return to the Favorites tab on the site.

By following these steps, you will be able to see the most recent changes you made to your notes. We apologize for the inconvenience caused by this bug and appreciate your understanding as we work to resolve it.