Skip to content

thesmartcoder7/gallery

Repository files navigation

Gallery Escape

Project Image

By: Samuel Martins

Table of Content

Description

This is a simple Django application for a personal gallery to showcase my photography skills. live site

Behaviour Driven Development

The user is able to;

  • View different photos that interest them

  • Click on a single photo to expand it and also view the details per photo. The photo appears on a modal within the same route as the main page.

  • Search for different photo categories within the app

  • Copy a link to the photo for sharing purposes

  • View photos based on the location they were taken

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

These are the things you need to install the software and how to install them

virtual enviroment:

$ pipenv shell

or

$ python3 -m venv virtual ( or your selected virtual enviroment name )

1. Local Repository

  • Make sure you have a stable internet to have the ability to clone the repository.
  • Type the following command in your terminal to clone this repository
git clone https://github.com/thesmartcoder7/gallery.git

If you are using SSH, use the following command

git clone git@github.com:thesmartcoder7/gallery.git

When you run the commands successfully, you should have a local version of this repository.

2. Online Repository

  • Make sure you have a stable internet for forking this repository.
  • According to the license, you can fork this project. You need to click on the forking icon and it will be added as one of your repositories

Feel free to fork the project and have fun with it. Happy coding!

Installing

To get a development env running, you simply need the install all the packages reguired from either a requirements.txt file or a pipfile. First you need to activate your virtual environment

$pipenv shell

of

$ source virtualenvname/bin/activate

after that, install all the required depencencies

$ pipenv install //pretty much takes care of installing all depencies for you

Now that all your dependencies are installed, you need to create a local database for your project and run migrations, or use the database that django comes with by default. The Make file has instructions for this.

$ make migrate

After this, you can run the application using the commands that come in the make file. for this case, it is either of the following:

$ make

or

$ make run

or

$ python manage.py runserver

Running the tests

If you want to run tests for the entire project, you need only run this command:

$ make test

or

$ python manage.py test

Technologies

  • HTML5
  • SCSS
  • JavaScript
  • Django

Licence

Copyright (c) Samuel Martins - MIT Licence

Author Info

Releases

No releases published

Packages

 
 
 

Contributors