Git Product home page Git Product logo

awaards's Introduction

AWWWARDS

Description

Awwards is a web application that allows users to share their projects and have them reviewed. The best projects are displayed for users to see.


Features

  • Posting projects to be reviewed.
  • Voting on projects.
  • Ranking of projects.
  • User authentication system: login and sign up.
  • Django admin dashboard for site management.

Getting started

Requirements

This project was created on a Ubuntu linux platform but should work on other unix based[not limited to] sytems.

  • Tested on Ubuntu Linux
  • Python3

Cloning the repository

git clone https://github.com/Vohsty/Awaards.git&& cd insta-clonewars

Creating a virtual environment

python3 -m virtualenv virtual
source virtual/bin/activate

Installing dependencies

pip3 install -r requirements

Prepare environmet variables

For this project you will need the following configurations plus email setup for email registration hmac verification.

SECRET_KEY= #secret key will be added by default
DEBUG= #set to false in production
DB_NAME= #database name
DB_USER= #database user
DB_PASSWORD=#database password
DB_HOST="127.0.0.1"
MODE= # dev or prod , set to prod during production
ALLOWED_HOSTS='.localhost', '.herokuapp.com', '.127.0.0.1'

Database migrations

python manage.py migrate

Running the server

python manage.py runserver

Admin Dashboard

Use django admin to manage the different users and posts.

Running the tests

python manage.py test

Live Demo

The web app can be accessed from the following link:

Technology used

Behaviour driven development/ Specifications

Behaviour Sample Input Sample Output
View Projects On sign in All projects displayed
Search for projects Submit search form All forms meeting the criteria are displayed
Post new project Submit new project upload form Project uploaded, view on feed
Rate a project Post ratings Ratings updated

Contributing

License (MIT License)

This project is licensed under the MIT Open Source license, (c) Steve Kimanthi

awaards's People

Contributors

vohsty avatar

Watchers

 avatar

Forkers

nivlapeter

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.