Giter Club home page Giter Club logo

picatrip's Introduction

GitHub forks GitHub issues GitHub pull requests GitHub top language Black Flake8

PicATrip

logo- picATrip

Who are we?

PicATrip is a web platform for sharing experiences from trips in a form of photos.

Other features It provides:

  • A trip search functionality by areas

  • Commenting functionality for trips shared on the platform

    PicATrip allows users to have the opportunity to contribute their trip experience and thoughts by picking a picture of a trip shared on the platform, and by that learn about the trips which stands behind the pictures, and having the opportunity to share their thoughts and comment if they desire.

Why using us?

Have you ever heard of the phrase 'eating with the eyes'? well that's about it! we believe in outdoor lifestyle and trips, and we strive to promote and encourage people to share their experience of trips in a form of a photo, only then when a user had an interest in a trip picture, he would be capable of getting more information about the trip, and comment his thoughts about it.

On days where we spending most of our time indoors, staring at screens, and being glued to our chair, whether it's as part of our studies, work, or as part of binging a series on the couch. We desire to change it and as wiser people have said- a photo worth a thousand words, then what's better than a thousand words to describe an experience of a trip.

Still not convinced?

As my mom used to say to me as a picky eater- " try first, and then we'll discuss it, what do you have to lose?"

Tools used for Development

  • Vagrant - a tool for using virtual machines to share development environments
  • PipEnv - a packaging tool for Python that solves some common problems associated with the typical workflow using pip, virtualenv, and the good old requirements
  • Django - a software framework for writing web applications using the Python programming language

Team members

Red Hat Open Source Course: Beyond05 - Team 2:

  • Leead Arbetman
  • Shoval Ovadia
  • Nadav Spinco
  • Ma'ayan Hadar

Contributing

For contributing please follow the instructions below:

  1. Fork the repository on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. push your work back up to your forked repo
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to fetch and merge the latest changes from the "upstream" repository before making a pull request!

Link to a Google Doc that contains our project structure:

https://docs.google.com/document/d/1yIkANtngk0St3hlGIb8Ed-mfT6NJMJJuPxsbtf5FiO8/edit?usp=sharing

picatrip's People

Contributors

amirmiller91 avatar eddev avatar guy9050 avatar leeadar avatar maayanhd avatar nadavspinco avatar peleghd avatar shiraos avatar shoval-ovadia avatar yarboa avatar

Watchers

 avatar  avatar  avatar  avatar

picatrip's Issues

Small fixes in Homepage and About us

  • Adding the main content from the Readme to the about us page (using semi-automatic .md file to HTML converter with small fixes)
  • Removing teammates that have been already left

Adding tests for commenting functionality

writing 'setup', 'body' and 'tear up' for testing functionality of commenting using pytest, covering:

  • model relation deletion
  • populating database and assertion
  • testing model functions

Make a web page

Make a static HTML file as the app demo page.

The file will contain the following details:

  • App name
  • Short Description
  • Team members names

This issue is dependent on #3

The file path should be:
picATrip\msgboard\templates \board.html

Adding a page for displaying post details - include comments

Adding for now a page for posts and details without considering the presentation of the images, later it will be merged with another page that is going to be dealing with this issue of presenting pictures by the saved URLs in the post objects.
This entire issue considering the comments - view part focusing on the forms subject of Django

Adding a new file

  • Adding a new HTML file so we can add some data into the page in the future

Update bootstrap script to run a Django application

  • Also update the script to run pipenv sync.
    This depends on a Pipfile.lock file that is created when installing Django (#3).

This task is dependent on Django having been installed on the Vagrant box (issue #3),
and on having a script to update (issue #7).

Updating README

Adding a link to the Google doc that includes the Application structure, features, feature story that describe the user experience etc.

Creating a base.html file

Creating a base template as the frame for all pages in the application.
The file will help us to avoid repeated code, and make changes in a single place.

Install flake8

Install flake8 in order to verify that the code we add conforms to proper Python syntax and coding standards.

Creating a commenting page

The commenting page will be a standalone page that the user will be redirected to when clicking on a "comment" button from the page that will be created for viewing a post.

for further details please check the google doc that elaborates the feature story in details (link appears on the bottom of the ReadMe file of the project)

Creating a documents folder

  • Create a folder that contains our documents and how the application is organized.
  • Adding a link to the Google doc that includes the Application structure, features, feature story that describe the user experience etc.

Automating model registration to admin site

Adding code to support automation of the model registration process to the admin site, providing a simpler interaction with the tables that represents each model in the DB - each column representing a field in the model.

Adding a post

Adding a page where the users see the following mandatory fields (and can fill them ):

  • Name of poster
  • Name of location
  • Main photo URL
  • Description of the experience

Upgrading ReadMe file

fixing issue #4

  • fixing the appearance of the ReadMe.md file
  • adding a logo for the project
  • adding technologies used for development
  • using more of Markup language capabilities

related issue: #4

signing in is not working

  1. vagrant up --provision
  2. go to localhost:8000/register
  3. fill in details and continue
  4. it throws an exception :
    image

Create a Vagrantfile

The way Vagrant works is that we create a file called Vagrantfile that contains the
instructions about how to create and bring up a virtual machine (VM) for working on our project.

We want to make sure that all the teammates can successfully use Git to clone the team project and Vagrant to bring up the development environment on their machines.

Adding a user model

Use the built-in Django authentication system for the basic fields and an additional table for more info

Formatting all files in systems using Black

Depends on the #77 issue and waiting for PR #80 in order to be merged (although not really necessary but it's generated based on the use of the pytest-black automate file formatting so It would be wiser to wait until it will be merged to check whether the test passed or not).

Connecting the postList page to the post detail URL

  • When clicked on post it will redirect to the post detail page by the post id, blocked until PR #73 will be merged.
  • In later versions will be replaced with clicking on the image of the post (after the feature of presenting a photo per post will be ready)
    closes PR #104

Adding urls tests

for each URL on our site, we need to check that it is referring to the correct view.

Better name to apphomepage

The folder that contains the views/models files named apphomepage.
I chose that name when I created the home page and now he seems wrong.
Please suggest a better name for this folder.

Update navigation bar

Update the navigation bar

  • register and login page will be shown before the user logged in.
  • logout and profile page will be shown after the user logged in.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.