https://github.com/nealwaga/awards
An application that allows a user to post a project he/she has created and get it reviewed by others.
https://github.com/nealwaga/awards
bootstrap4 css3 django django-rest-framework html5 javascript jquery postgresql python3
Last synced: 3 months ago
JSON representation
An application that allows a user to post a project he/she has created and get it reviewed by others.
- Host: GitHub
- URL: https://github.com/nealwaga/awards
- Owner: nealwaga
- License: mit
- Created: 2022-06-10T07:11:36.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-13T11:30:43.000Z (about 4 years ago)
- Last Synced: 2025-02-27T05:30:30.077Z (over 1 year ago)
- Topics: bootstrap4, css3, django, django-rest-framework, html5, javascript, jquery, postgresql, python3
- Language: Python
- Homepage: https://neal-awards.herokuapp.com/
- Size: 23.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Awards
This is an application that allows users to create accounts and add projects as well as vote for other users projects based on design, usability and content.
## User Story
A user can sign in to the application to start using.
A user can upload my websites to the application.
A user can view any profile with all websites.
A user can rate a website.
## Author
[Neal Waga](https://github.com/nealwaga)
## Technology used
* Python3
* Django
* Postgress
* HTML5
* CSS3
* JavaScript
* jQuery
* Bootstrap 4
## Requirements
An IDE such as VS Code with Python version 3 installed, a terminal and a browser.
## Installations
The following command installs all the application requirements
>``pip freeze -r requirements.txt``
## Setup
Run
``https://github.com/nealwaga/Awards.git``
or download the zip file from github.
After extracting the files,
1. Navigate to the project folder
>`` cd name_of_folder``
2. Creating a virtual environment
>``virtualenv virtual``
3. Activating the virtual environment
>``source virtual/bin/activate``
4. Running the application
>``python3 manage.py runserverserver``
5. Running tests
> ``python3 manage.py test.``
## Behaviour Driven Development
BDD focuses on how the user will interact with the application. What you will see and experience:
1. Landing page with various projects from different users. A navigation bar as well with home, login and register routes.
2. Create an account with a unique username,an email and password. You will receive an email and redirected to login, you'll be required to login to vote for any project.
3. User can also create and update their profile.
4. Profile view displays users projects, click on the image to view more details of the project and get access to a live link.
5. Click on the upload project svg to add a project for others to view.
## Known Bugs
None, but if you find a bug or would like to request a new function, reach out to me via Gmail: waganeal@gmail.com or on [LinkedIn](https://www.linkedin.com/in/nealwaga/)
## [License](https://github.com/nealwaga/Awards/blob/master/LICENSE)
## Collaborate
For any collaborations, reach me on waganeal@gmail.com