Giter VIP home page Giter VIP logo

kellykiiru / django-ip3 Goto Github PK

View Code? Open in Web Editor NEW
1.0 0.0 0.0 11.82 MB

This is a clone of awwards.com application where a user can rate projects by other developers and even their own projects.

Home Page: https://kiiruawwards.herokuapp.com/

License: MIT License

Python 37.09% HTML 42.14% PowerShell 14.61% Shell 6.12% Procfile 0.04%
django django-rest-framework python html css4 javascript jquery

django-ip3's Introduction

Project Awwards

By Kelly Kiiru

Description

This is a clone of awwards.com application where a user can rate projects by other developers and even their own projects.

Table of Content

Setup Installations Requirements

  • To run the application, in your terminal:
1. Clone this [github repo] (https://github.com/KellyKiiru/django-ip3.git)
2. Create a virtual environment
3. Read the requirements file and Install all the requirements. Or run pip3 install -r requirements.txt to automatically install all the requirements
4. Run server depending on your python interpreter

Prerequisites

You must have git, django, postgres and python3.8+ installed in your pc. To install django and Postgres, you can use the following commands:

#django $ pip install django

#postgres $ sudo apt-get install postgresql postgresql-contrib libpq-dev

Development

Want to contribute? Great!

To fix a bug or enhance an existing module, follow these steps:

  • Fork the repo
  • Create a new branch (git checkout -b improve-feature)
  • Make the appropriate changes in the files
  • Add changes to reflect the changes made
  • Commit your changes (git commit -am 'Improve feature')
  • Push to the branch (git push origin improve-feature)
  • Create a Pull Request

Deployment environment

  • Heroku

BDD

User Requirements Input Output
View Projects Go to the home page Projects by other users will be displayed
Rate Projects Click on project link to rate it Project is displayed solely for rating
Add Projects Click on submit site button Fill in a form to add pdoject for rating

TDD

To test the app, run this command in the terminal;

$ python3 manage.py test

User Story

  • View projects by other users.
  • User signs up and logs in.
  • User edits their profile
  • Add projects.
  • User can give his rating for projects they desire to rate.

Technology & Tools

  • Python
  • Django
  • HTML
  • CSS
  • Bootstrap
  • Postgres
  • Javascript(jQuery)
  • Pip

Reference

License

MIT License

Copyright (c) 2022 Kelly Kiiru

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Authors Contact Details

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.