melisajuma/awards

The application will allow a user to post a project he/she has created and get it reviewed by his/her peers.

Awards

Author: Melisa Juma

Description

The application will allow a user to post a project he/she has created and get it reviewed by his/her peers.

User Stories

• View posted projects and their details
• Post a project to be rated/reviewed
• Rate/ review other users' projects
• Search for projects
• View projects overall score
• View my profile page

BDD

Behavior	Input	Output
login/sign up	enter user details	view site
Search for different categories	project id	displays projects of that category
Filter projects	click a button	displays projects

Prerequisites

• Python3.6
• django
• Postgresql

Setup/Installation Requirements

• Internet access
• $ git clone : https://github.com/melisajuma/Awards.git
• $ cd Awards
• $ python3.6 -m venv virtual (install virtual environment)
• $ source virtual/bin/activate
• $ python3.6 -m pip install -r requirements.txt (install all dependencies)
• Run "python3 manage.py runserver" from the terminal

How the app works

• A user needs to log in if they have na existing account
• A user can sign up f they do not have an account
• A user then can be able to view a persons profile and the projects they have worked on.

Contacts

For further questions you can send an email to [email protected]

Known bugs

No known errors. However, if found, contact me here ## Known bugs

No known errors. However, if found, contact me here

Technologies used

• Python3.6
• django framework
• Bootstrap
• PostgreSQL

Contributing

Any contributions to this projects will be greatly appreciated. If you want to contribute to it, here are the suggested instructions:

• Clone this GitHub repository to your local machine.

git clone https://github.com/melisajuma/Awards.git

• Make your contributions.
• Email me the zipped project at [email protected] , or
• Request permissions to post your contribution at my GitHub repository through the same email address.

Versioning

Used GIT and GitHub. There are commits attached to the entire project to show the management of versions.

Copyright

All Rights Reserved by @Melisa JUma Other GitHub can however fork or clone this repository provided the necessary credit is given to the original author.

License

This project is licensed under the MIT License. Moringa School moreover retains certain rights to elements in the code of this program.