Ready to explore? CityByte is the perfect tool to prepare for a trip or just virtually wander the globe. We've been hard at work to deliver new features, and we hope you enjoy. Below you can find an explination of recent updates, information about this codebase, and even how to host it yourself!
The start guide can be found in the INSTALL.md file.
- Multiple pins on map - quick and easy way to check multiple places one time on the map
- Sheduling and Organizing Improvements - Itinerary items can now be arranged according to the date and time they have been scheduled at!
- Summarization of Trip Itinerary - Save the locations you want to go in each city so you don't forget and review all your favorites locations!
https://www.youtube.com/watch?v=LJNfWGS4qw8
6LELQXAW6XYR43FB.mp4
The old project's updates can be seen by going to the old branch and navigating to that README. In short, Phase 1 was the project's initial creation via command line and Phase 2 was transitioning to a webapp, creating user accounts, and using caching to reduce system crashes and increase overall speed. Project 2 from prior team was trying to add logins, UI improvements and Trip Itinerary.
First, credit to the prior team's members. They made the project easy to pick up and use and most of the automated tools used for this come from them. We hope that we've ensured the project is as easy to pick up and use as them (if not more so).
We use GitHub actions to automate tasks of linting, code coverage, build, tests, and security checks. The codes that perform these actions are stored as .yml files in the .github/workflows directory. The GitHub actions are triggered whenever something is pushed (or pulled) into the remote repository. The results of these automated tasks are shown as badges at the top of this README.md file.
Unit test are performed everytime there is a push or pull into the repository. They are present in /search/tests.py.
Code Coverage is an important metric that allows us to understand how much of the codebase is tested. django.yml performs this task. For more information about Code Coverage, please visit this link.
We are using Flake8 for linting and syntax checking, and it is performed by Linting.yml. For more information about Flake8, please visit this link.
Use flake8 before you push code to GitHub.
Config file present in .flake8.
flake8 <directory>
We are using the Black code formatter to format our code before pushing it to GitHub. For more information about Black, please visit this link.
Config file in pyproject.toml.
Run the line below every time you push to GitHub.
black --line-length 120 <filename>
If you prefer using Black in VSCode, you can add the below settings in your vscode settings:
{
"python.formatting.provider": "black",
"python.formatting.blackArgs": ["--line-length", "120"],
"python.linting.enabled": true
}
Run pre-commit install to automatically enable Black and Flake8 upon commits.
Distributed under the MIT License. See LICENSE.md for more information
Concerns with the software? Please get in touch with us via one of the methods below. We are delighted to address any queries you may have about the program.
Please contact us if you experience any problems with the setting up the problem or would like help understanding the code. You can email us at gunabanagroup [at] gmail [dot] com or by clicking the icon below.
- Dharani Guda - dguda
- Archismita Ghosh - aghosh7
- Brody Bond - bbond
- Chaitanya Nagulapalli - cknagula
- Tristan Hall - tdhall6
- Rohit Geddam: sgeddam2@ncsu.edu
- Arun Kumar Ramesh - arames25@ncsu.edu
- Kiron Jayesh - kjayesh@ncsu.edu
- Sai Krishna Teja Varma - smanthe@ncsu.edu
- Shandler Mason - samason4@ncsu.edu
- Nirav Shah - nshah28
- Vishwa Gandhi - vgandhi
- Pradyumna Khawas - ppkhawas
- Vrushanki Patel - vpatel25
- Priya Saroj - pbsaroj