Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
San12R authored Oct 26, 2023
commit 3f21240c6a028052f29de5863be739741a6ee2ea
47 changes: 41 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,53 @@ To get started with the Code-with-Google-Maps-2023 repository, follow these step

### README.md must consist of the following information:

#### Team Name -
#### Problem Statement -
#### Team Leader Email -
#### Team Name - Meliora
#### Problem Statement - Development of an application for enhanced routing and road
safety of the users based on multiple factors
#### Team Leader Email - [email protected]

### A Brief of the Prototype:
This section must include UML Diagrams and prototype description
A web application for enhanced routing and road safety of the users based on
multiple factors like road information, volume of travellers over a route and its safety
rating, users' vehicle information, emergency alerts and other traffic signs over the route
using Google Maps APIs and retrieve details and markers through API endpoints.
The code allows users to vote for the suitability of a road for different types of vehicles (small vehicles, cars, and big vehicles), view road details, and add markers for new roads.

### Tech Stack:
List Down all technologies used to Build the prototype
1. Server side:
a. Application:
Python: Flask framework
flask-SQLAlchemy ORM
b. Backend:
SQLite RDBMS
2. Frontend:
HTML
CSS
Jinja
JavaScript

### Step-by-Step Code Execution Instructions:
This Section must contain a set of instructions required to clone and run the prototype so that it can be tested and deeply analyzed
*Please note that these instructions are specifically for Windows Operating Systems, and they may vary for other operating systems.

1. Begin by downloading the provided folder, which contains all the necessary files.

2. Once you have downloaded the folder, open the terminal (cmd) within it.

3. Activate the virtual environment named "gmapenv" using the following command: "gmapenv\scripts\activate".

4. After successfully activating the virtual environment, you can check the code if you have IDE such as the Visual Studio Code (VSCode) installed.
5. Execute the following command: code ..

6. With the virtual environment set up, you can now run the application on your local server. In the command prompt, type and execute: "python main.py".

7. You can see the message: "Running on http://127.0.0.1:5000."

8. Copy and paste the localhost address from previous step, which is "http://127.0.0.1:5000," into your web browser's address bar to view the application.

9. Press "ctrl+c" to stop the application from the cmd.
10. Type "deactivate" in the command prompt to deactivate the virtual enviroment.
11. type "exit" to exit the cmd.


### Future Scope:
Write about the scalability and futuristic aspects of the prototype developed