diff --git a/CODE_OF_CONDUCT.md b/CODE-OF-CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to CODE-OF-CONDUCT.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3098f26c..919ed52b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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:help@packtravel.io) 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 diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 00000000..6d3c45c7 --- /dev/null +++ b/INSTALL.md @@ -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:
+Linux/MacOS: `source .venv/bin/activate`
+Windows: `.venv/Scripts/activate`
+ +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 +``` diff --git a/LICENSE b/LICENSE index 90faebad..41c7ad44 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Amisha Waghela +Copyright (c) 2022 VSangarya Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 8ea7b86a..b173ce4d 100644 --- a/README.md +++ b/README.md @@ -1,181 +1,33 @@ -
- - -# `PackTravel` - - - - - -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7178601.svg)](https://doi.org/10.5281/zenodo.7178601) -[![codecov](https://codecov.io/gh/amisha-w/PackTravel/branch/main/graph/badge.svg?token=HRFN97UEB7)](https://codecov.io/gh/amisha-w/PackTravel) -![Python Style Checker](https://github.com/amisha-w/PackTravel/actions/workflows/python_style_checker.yml/badge.svg) -![Lint Python](https://github.com/amisha-w/PackTravel/actions/workflows/pylint.yml/badge.svg) - -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT) -[![contributors](https://img.shields.io/github/contributors/amisha-w/PackTravel?style=for-the-badge)](https://github.com/amisha-w/PackTravel/graphs/contributors) -[![Total Lines](https://img.shields.io/tokei/lines/github/amisha-w/PackTravel?style=for-the-badge)](https://img.shields.io/tokei/lines/github/amisha-w/PackTravel) -[![Issues](https://img.shields.io/github/issues/amisha-w/PackTravel?style=for-the-badge)](https://github.com/amisha-w/PackTravel/issues) -[![Closed Issues](https://img.shields.io/github/issues-closed-raw/amisha-w/PackTravel?style=for-the-badge)](https://github.com/amisha-w/PackTravel/issues?q=is%3Aissue+is%3Aclosed) -[![Pull Requests](https://img.shields.io/github/issues-pr/amisha-w/PackTravel?style=for-the-badge)](https://github.com/amisha-w/PackTravel/pulls) -[![Commit Acitivity](https://img.shields.io/github/commit-activity/w/amisha-w/PackTravel?style=for-the-badge)](https://github.com/amisha-w/PackTravel/graphs/commit-activity) -[![Repo Size](https://img.shields.io/github/repo-size/amisha-w/PackTravel?style=for-the-badge)](https://github.com/amisha-w/PackTravel) - - -
-

🏆 Goal

- -_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. - - - - - -**So, let's PackTravel 😎** - -

Features

- - - -## 🚀 A bit abut PackTravel +# 🐺 PackTravel +[![Commit Acitivity](https://img.shields.io/github/commit-activity/w/VSangarya/PackTravel)](https://github.com/VSangarya/PackTravel/pulse) +[![Issues](https://img.shields.io/github/issues/VSangarya/PackTravel?color=red)](https://github.com/VSangarya/PackTravel/issues) +[![Contributors](https://img.shields.io/github/contributors/VSangarya/PackTravel)](https://github.com/VSangarya/PackTravel/graphs/contributors) +[![License](https://img.shields.io/github/license/VSangarya/PackTravel)](LICENSE) +![Languages](https://img.shields.io/github/languages/count/VSangarya/PackTravel) +[![Code Size](https://img.shields.io/github/languages/code-size/VSangarya/PackTravel)](https://github.com/VSangarya/PackTravel/) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE-OF-CONDUCT.md) +[![Repo Size](https://img.shields.io/github/repo-size/VSangarya/PackTravel)](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 +* Search and view rides posted by other users +* Join rides https://user-images.githubusercontent.com/111834635/194171771-962a585e-5dc7-4ea3-af35-732ebd34e76c.mp4 -**Built Using:** -
- - - - - - - - - - - -## 📖 Getting started: - -### 👤 Who can use our app - - 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 help@packtravel.io 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** -![](https://github.com/amisha-w/PackTravel/blob/main/images/Login%20(1).gif) - -- **Creating a Ride** -![](https://github.com/amisha-w/PackTravel/blob/main/images/Create1.gif) -![](https://github.com/amisha-w/PackTravel/blob/main/images/Create2.gif) - -- **Search for a Ride** -![](https://github.com/amisha-w/PackTravel/blob/main/images/Search.gif) - -- **Joining an existing Ride** -![](https://github.com/amisha-w/PackTravel/blob/main/images/JoinRide.gif) - -- **Adding New Route** -![](https://github.com/amisha-w/PackTravel/blob/main/images/AddRoute11.gif) -![](https://github.com/amisha-w/PackTravel/blob/main/images/AddRoute12.gif) - -- **Sign Up Page** -![](https://github.com/amisha-w/PackTravel/blob/main/images/Register.gif) - - - - -## 💬 Chat Channel - - - - -### 🎯 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 help@packtravel.io 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 - - - - - - - - - -

Amisha Waghela
Aoishi Das

Ameya Chavan

Kunal Shah

Swarnamalya M
- - -

❗ TroubleShooting and Help Guide

- - 1. For any issues faced while using the application, please email the detailed description and steps to reproduce the error at help@packtravel.io . - 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. +* mquresh@ncsu.edu +* apandit3@ncsu.edu +* vnagara3@ncsu.edu +* schopra4@ncsu.edu +* lsangar@ncsu.edu