forked from amisha-w/PackTravel
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from VSangarya/readme
Cleanup and Install.MD
- Loading branch information
Showing
5 changed files
with
63 additions
and
195 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,7 @@ The following is a set of guidelines for contributing to PackTravel. | |
| [How Can I Contribute?](#how-can-i-contribute) | ||
| * [Reporting Bugs](#reporting-bugs) | ||
| * [Suggesting Enhancements](#suggesting-enhancements) | ||
| * [Style Guides](#style-guides) | ||
| * [Pull Requests](#pull-requests) | ||
|
|
||
|
|
||
|
|
@@ -55,6 +56,8 @@ This section guides you through submitting an enhancement suggestion, including | |
| * **Drop an [email](mailto:[email protected]) suggesting your change and start writing code.** | ||
| * **Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.** | ||
|
|
||
| ### Style Guides | ||
| This project uses Python linter to ensure the code style is uniform and conforms to a well known syntactical style: [Pylint analyser](https://pylint.pycqa.org/en/latest/). | ||
|
|
||
| ### Pull Requests | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # 👩🏼💻 🚀 Developer Environment Setup | ||
| ## Prerequisites | ||
| 1. Python 3.6+ | ||
| 2. VS Code (to make collaboration easier. We don't want to argue over tabs vs spaces!) | ||
| 3. MongoDB Cloud Account: After setting up your free account on [MongoDB](https://www.mongodb.com/cloud/atlas/register) cloud, you will have a username, password and the database connection string. | ||
| ## Setup | ||
| 1. Clone this repository to your local machine. | ||
|
|
||
| 2. Change terminal to repository directory and create a new virtual environment using venv: `path/to/python -m venv .venv` | ||
|
|
||
| 3. Activate virtual environment:<br/> | ||
| Linux/MacOS: `source .venv/bin/activate`<br/> | ||
| Windows: `.venv/Scripts/activate`<br/> | ||
|
|
||
| 4. Install Python dependencies | ||
| ```Text | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| 5. Add your MongoDB connection string and user credentials to the `config.yml` file in the repository root directory. | ||
|
|
||
| 6. Start the development server using the following commands | ||
| ```Text | ||
| python manage.py migrate | ||
| python manage.py runserver | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,181 +1,33 @@ | ||
| <div align="center"> | ||
|
|
||
| <img style="width: 120px; height: 120px;" src="./images/wolf2.svg"></img> | ||
| # `PackTravel` | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| [](https://doi.org/10.5281/zenodo.7178601) | ||
| [](https://codecov.io/gh/amisha-w/PackTravel) | ||
|  | ||
|  | ||
|
|
||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://github.com/amisha-w/PackTravel/graphs/contributors) | ||
| [](https://img.shields.io/tokei/lines/github/amisha-w/PackTravel) | ||
| [](https://github.com/amisha-w/PackTravel/issues) | ||
| [](https://github.com/amisha-w/PackTravel/issues?q=is%3Aissue+is%3Aclosed) | ||
| [](https://github.com/amisha-w/PackTravel/pulls) | ||
| [](https://github.com/amisha-w/PackTravel/graphs/commit-activity) | ||
| [](https://github.com/amisha-w/PackTravel) | ||
|
|
||
|
|
||
| </div> | ||
| <h1>🏆 Goal</h1> | ||
|
|
||
| _Travelling alone?_ **Try PackTravel** | ||
|
|
||
|
|
||
| **Project Description:** | ||
|
|
||
| Most of the university students do not have a car to travel off-campus and rely mostly on the Wolfline. But what if someone wants to travel outside Wolfline's limit? Well... why not collaborate on PackTravel to travel off-campus by a cab, rental car, etc. | ||
|
|
||
|
|
||
|
|
||
| <img style="width: 320px; height: 200px;" src="https://user-images.githubusercontent.com/111834635/194171695-02f5bda6-af44-4e9e-a1a5-4d734c7af5de.jpg" alt=""/> | ||
|
|
||
| **So, let's PackTravel 😎** | ||
|
|
||
| <h1>Features</h1> | ||
|
|
||
| <ul> | ||
| <li>Create a PackTravel Ride</li> | ||
| <li>Create mmultiple routes to reach a ride's destination: Bus, Cab or Personal</li> | ||
| <li>Search and view other's rides</li> | ||
| <li>Join a PackTravel Ride's route</li> | ||
|
|
||
| </ul> | ||
|
|
||
| ## 🚀 A bit abut PackTravel | ||
| # 🐺 PackTravel | ||
| [](https://github.com/VSangarya/PackTravel/pulse) | ||
| [](https://github.com/VSangarya/PackTravel/issues) | ||
| [](https://github.com/VSangarya/PackTravel/graphs/contributors) | ||
| [](LICENSE) | ||
|  | ||
| [](https://github.com/VSangarya/PackTravel/) | ||
| [](CODE-OF-CONDUCT.md) | ||
| [](https://github.com/VSangarya/PackTravel/) | ||
|
|
||
| _Travelling alone?_ **Let's PackTravel!** | ||
|
|
||
| Most university students do not have a car and rely on Wolfline. But what if you want to travel outside Wolfline's limit? Well...why not collaborate on PackTravel to travel off-campus by a cab, rental car, etc. | ||
|
|
||
| ## 💎 Features | ||
| * Create a ride | ||
| * Create multiple routes to any destination: Bus, Cab or Personal</li> | ||
| * Search and view rides posted by other users</li> | ||
| * Join rides | ||
|
|
||
| https://user-images.githubusercontent.com/111834635/194171771-962a585e-5dc7-4ea3-af35-732ebd34e76c.mp4 | ||
|
|
||
| **Built Using:** | ||
| </br> | ||
| <code><a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/w3_html5/w3_html5-ar21.svg"></a></code> | ||
| <code><a href="https://developer.mozilla.org/en-US/docs/Web/CSS" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/w3_css/w3_css-ar21.svg"></a></code> | ||
| <code><a href="https://getbootstrap.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/getbootstrap/getbootstrap-ar21.svg"></a></code> | ||
| <code><a href="https://www.javascript.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/javascript/javascript-ar21.svg"></a></code> | ||
| <code><a href="https://www.djangoproject.com/" target="_blank"><img height="50" src="https://user-images.githubusercontent.com/111834635/194172149-ff6a56be-3025-4d2c-8cdb-b9a7e3f87259.png"></a></code> | ||
| <code><a href="https://www.mongodb.com/" target="_blank"><img height="50" src="https://user-images.githubusercontent.com/111834635/194173280-628ecfc0-21ae-4870-8e22-711e6da83820.png"></a></code> | ||
| <code><a href="https://www.python.org/" target="_blank"><img height="50" src="https://user-images.githubusercontent.com/111834635/194173533-37cd4997-55f3-4bb1-87bd-1a16a3af53aa.png"></a></code> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## 📖 Getting started: | ||
|
|
||
| ### 👤 Who can use our app</h1> | ||
|
|
||
| 1. If you are a user who is visiting our app, you can sign up as a user with view access to rides. You can edit or create your own ride. | ||
| 2. If you are an admin user, you can create, view, update and delete rides and schedule rides. | ||
| 3. To request for admin privileges, please email on [email protected] with the purpose of use. | ||
|
|
||
| - ### Prerequisite: | ||
| - Download [Python3.x](https://www.python.org/downloads/). | ||
| - Download [Django](https://docs.djangoproject.com/en/4.1/topics/install/). | ||
|
|
||
| ## Run Locally | ||
|
|
||
| Create a virtual environment: | ||
|
|
||
| ```bash | ||
| python3.x -m venv test_env | ||
| ``` | ||
|
|
||
| Activate the virtual environment: | ||
| Linux/MacOS: | ||
| ```bash | ||
| source test_env/bin/activate | ||
| ``` | ||
| Windows: | ||
| ```bash | ||
| ./test_env/Scripts/activate | ||
| ``` | ||
|
|
||
| Clone the project | ||
|
|
||
| ```bash | ||
| git clone https://github.com/amisha-w/PackTravel.git | ||
| ``` | ||
|
|
||
| Go to the project directory | ||
|
|
||
| ```bash | ||
| cd PackTravel | ||
| ``` | ||
|
|
||
| Install dependencies | ||
|
|
||
| ```bash | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| Start the server | ||
|
|
||
| ```bash | ||
| python manage.py migrate | ||
| python manage.py runserver | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| - Site will be hosted at: | ||
| `http://127.0.0.1:5000/` | ||
| ## 🛠️ Tools | ||
| - [Preetier Code Formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | ||
| - [JS-HTML-CSS Formatter](https://marketplace.visualstudio.com/items?itemName=lonefy.vscode-JS-CSS-HTML-formatter) | ||
| - [PyLint](https://pylint.org/) | ||
|
|
||
| ## 🧑💻 Functionalities in Action | ||
|
|
||
| - **Login Page** | ||
| .gif) | ||
|
|
||
| - **Creating a Ride** | ||
|  | ||
|  | ||
|
|
||
| - **Search for a Ride** | ||
|  | ||
|
|
||
| - **Joining an existing Ride** | ||
|  | ||
|
|
||
| - **Adding New Route** | ||
|  | ||
|  | ||
|
|
||
| - **Sign Up Page** | ||
|  | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## 💬 Chat Channel | ||
|
|
||
| <code><a href="https://app.slack.com/client/T03UZM4975G/C03UT3QFHP0" target="_blank"><img height="50" width="100" src="https://user-images.githubusercontent.com/111834635/194175304-834d5663-b6bb-4e38-981d-98bc1bf028b8.png"></a></code> | ||
|
|
||
|
|
||
| ### 🎯 Phase 1: | ||
|
|
||
| - [x] Create database ER diagram | ||
| - [x] Create Mongo Database | ||
| - [x] Create HomePage | ||
| - [x] Create Login and Signup Page | ||
| - [x] Create Search Page | ||
| - [x] Added create Rides Page | ||
| - [x] Added create routes Page | ||
| - [x] Setup Django | ||
| - [x] Add Unit testing | ||
| - [x] Add Error Handling mechanisms | ||
| - [x] Setup Workflows | ||
|
|
||
| ### 🎯 Future Enhancements: | ||
| ## 📖 Usecases | ||
| * Users: Create new rides, view and join available rides. | ||
| * Administrators: User permissions + update, delete or schedule rides. To request administrator access, please email on [email protected] with the purpose of use. | ||
|
|
||
| ## ⚒️ Installation | ||
| * See [developer environment setup](INSTALL.md#--developer-environment-setup) to setup your development server. | ||
|
|
||
| ## 🎯 Enhancements | ||
| - [ ] Add machine learning algorithms for predicting lowest priced rides, best pickup and drop-off locations. | ||
| - [ ] Add functionality to merge routes | ||
| - [ ] Show later departures in search if currently searched rides is not available | ||
|
|
@@ -184,23 +36,10 @@ Start the server | |
| - [ ] Integrate in-app cab booking services | ||
| - [ ] Introduce a two way ride confirmation feature | ||
|
|
||
| ## Contributions to the Project | ||
|
|
||
| ## 👨🏭 Contributors | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/amisha-w"><img src="https://avatars.githubusercontent.com/u/40361766?v=4" width="100px;" alt=""/><br /><sub><b>Amisha Waghela</b></sub></a></td> | ||
| <td align="center"><a href="https://github.com/Aoishi28"><img src="https://avatars.githubusercontent.com/u/60925790?v=4" width="100px;" alt=""/><br /><sub><b>Aoishi Das</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/ameyachavan26"><img src="https://avatars.githubusercontent.com/u/111834635?v=4" width="100px;" alt=""/><br /><sub><b>Ameya Chavan</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/kunalshah03"><img src="https://avatars.githubusercontent.com/u/48029057?v=4" width="100px;" alt=""/><br /><sub><b>Kunal Shah</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/swarnamalyamohan"><img src="https://avatars.githubusercontent.com/u/45752623?v=4" width="100px;" alt=""/><br /><sub><b>Swarnamalya M</b></sub></a><br /></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
|
|
||
| <h1>❗ TroubleShooting and Help Guide</h1> | ||
|
|
||
| 1. For any issues faced while using the application, please email the detailed description and steps to reproduce the error at [email protected] . | ||
| 2. If you are a developer, please raise an issue on github with steps to reproduce and possible source of error. | ||
| 3. Our email is monitored 24x7 and we usually respond within 1 hour. Happy Emailing :). | ||
| ## 📨 Help and Troubleshooting | ||
| For any help or assistance regarding the software, please e-mail any of the developers with the query or a detailed description. Additionally, please use issues on GitHub for any software related issues, bugs or questions. | ||
| * [email protected] | ||
| * [email protected] | ||
| * [email protected] | ||
| * [email protected] | ||
| * [email protected] | ||