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
- Description
- Setup/Installation Requirements
- BDD & TDD
- UserStory
- Technology & Tools
- Reference
- Licence
- Authors Info
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.