ProjectReview

By

Description

ProjectReview is a Django application that allows users to view projects posted by others and to post their own projects for others to review. The application has an authentication system that allows users to sign up and login to use the main features of the application like posting a project and rating projects posted by others. ProjectReview allows users to view posted projects on the home page, to view project details of each project by clicking them and to review those projects. It also allows users to post their projects with a description of the project and a live link for the hosted application. The application has a user profile page that displays user details like the profile picture, username, login user email and the bio on login. Users can change their profile picture and edit the bio to their preference.

Installation Requirements

Python version 3
pip
Django
Pillow
Postgresql
The virtual environment

Setup

To set up this application:

Fork this repository to your github account.
Open the terminal on your pc and navigate to the specific folder location that you want this directory to be stored.
Clone the forked repository in your account to the specific folder chosen, through the git clone command.
Navigate to the specific location you cloned the project into.
Open the project using vs code using command code . or atom . depending on the text editor you're using.
Activate the virtual environment.
Install all the requirements.

Running the Application

To run the application, open the cloned file in terminal and run the following command:
```
  $ python3 manage.py runserver
```
To run tests for the application run the following command:
```
  $ python3 manage.py test
```

Technologies Used

Technologies used in the development of this project include:

Python3
Django
Bootstrap
HTML
CSS
Pillow
Psql

Known Bugs

There are currently no known bugs.

Support and contact details

If the application malfunctions or develops a problem, feel free to contact me through email at abigailwachira@gmail.com

License

This project is under the:

MIT License

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.

NyawiraWachira/ProjectReview