/awwwards

An application that allows a user to post a project he/she has created and get it reviewed by their peers.

Primary LanguagePythonOtherNOASSERTION

Awwwards

An application that allows a user to post a project he/she has created and get it reviewed by his/her peers.

Author

Getting Started

Fork this repository or clone it to your local machine running Ubuntu by using the following commands:

git clone (https://github.com/Marcusjnls/awwwards.git)

Behavior Driven Development

  • The program should navigate to the index page on load:

    Input Example: On page load

    Output Example: Navigate to the home/index page

  • The program should navigate to sign up page when Sign Up is clicked on the navigation bar:

    Input Example: Click on Sign Up on the navigation bar

    Output Example: Redirected to the sign up page

  • The program should navigate to the login page when Login is clicked on the navigation bar:

    Input Example: Click on Login on the navigation bar

    Output Example: Redirected to the login page

  • The program should direct the user to the page with a single project with description and vote button:

    Input Example: Click on See More

    Output Example: Redirected to the single project page with the project's description

  • The program should navigate to the vote form when Vote is clicked:

    Input Example: Click on Vote button

    Output Example: A vote form pops up

  • The program should navigate to the profile editing form when the My Account is clicked on the navigation bar:

    Input Example: Click on My Account on the navigation bar

    Output Example: Redirected to the profile editing form

  • The program should load the live site on a new tab when View Site is clicked:

    Input Example: Click on View Site

    Output Example: Live site of a specific project loads on a new tab

Prerequisites

You will need to be running the following:

  • Python version 3.6
  • Postgres database

Installing

A step by step series of examples that tell you how to get a development env running

  • git clone https://github.com/Marcusjnls/awwwards.git

  • set up a virtual environment using the following command

python3.6 -m venv --without-pip virtual

And activate it

source virtual/bin/activate
  • install the latest version of pip
curl https://bootstrap.pypa.io/get-pip.py | python
  • Install the requirements in the requirements.txt file using
pip install -r requirements.txt
  • create a .env file in your rootfolder and add the following configurations
SECRET_KEY='<random-string>'
DEBUG=True
ALLOWED_HOSTS='*'
DATABASE_URL='postgres://databaseowner:password@localhost/databasename'
  • create postgres database
CREATE DATABASE <your-database-name>
  • create a migration using the following command
python3.6 manage.py makemigrations

and migrate

python3.6 manage.py migrate
  • create an admin account
python 3.6 manage.py createsuperuser

and fill-in your credentials

  • run the application using
python3.6 manage.py runserver
  • navigate to the admin panel by typing
localhost:8000/admin

Running the tests

Run the following commands:

python3.6 manage.py tests

Deployment

View the following document inorder to deploy to a live system

Built Using

Contact Info

License

This project is licensed under the MIT License - see the LICENSE file for details