https://github.com/machariamark/awwards
A web application to post websites and other web projects as well as review posted projects.
https://github.com/machariamark/awwards
Last synced: about 1 year ago
JSON representation
A web application to post websites and other web projects as well as review posted projects.
- Host: GitHub
- URL: https://github.com/machariamark/awwards
- Owner: MachariaMark
- Created: 2021-10-22T11:31:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-23T12:54:45.000Z (over 4 years ago)
- Last Synced: 2025-02-02T08:11:22.085Z (over 1 year ago)
- Language: Python
- Homepage: https://awwardss.herokuapp.com/
- Size: 34 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## AWWARDS
22.10.2021
#### By **Mark Muchiri Macharia**
## Description
A web application to post websites and other web projects as well as review posted projects.
## Features
* Users create an account.
* Users can log in to application and view other peoples projects once they have an account.
* Users can view other users' profiles and their projects.
* Users can search projects by title.
* Users can upload and post their projects.
* Users can view their profiles and edit their profile pictures and bio.
* Users can review and post a review on other users' projects.
# Specifications
## BDD
| Behavior | Input | Output |
| ------------------- | ----------------------------- | ----------------------------- |
| Users can sign up for an account | Input credentials in the registration form then click Sign Up | Users are prompted to login into their account |
| Users can view projects posted by other users | Click on a specific project's review button | When clicked, users are navigated to another page where they can post a review of the project |
| Users can view the full live site of a posted project | Click on the 'Go to Site' button | Users are directed to the live site of the posted project |
| Users can view and edit their profiles | Click on profile in the side navigation | Users are directed to their profile page with their posted projects displayed as well as their profile information and an option to edit it |
| Users can search projects | Click on the search icon on the navigation bar, type in a given project-title and press Enter | User will be able to view projects with that title |
## Setup/Installation Requirements
Here is a run through of how to set up the application:
* Step 1 : Clone this repository using the git clone link:
* **`git clone https://github.com/MachariaMark/Awwards.git`**
* Step 2 : Navigate to the directory:
* **`cd Awwards`**
* Step 3 : Open the directory created with your favorite IDE. If Atom type **`atom .`** if VSCode type **`code .`** . This will lauch the editor with the project setup,
* Now feel free to hack around the project.
## Known Bugs
* None currently.
## Getting started
### Prerequisites
* python3.6
* virtual environment
* pip
### Cloning
* In your terminal:
$ git clone https://github.com/MachariaMark/mygallery.git
$ cd mygallery
## Running the Application
* Install virtual environment using `$ python3.6 -m venv --without-pip virtual`
* Activate virtual environment using `$ source virtual/bin/activate`
* Download pip in our environment using `$ curl https://bootstrap.pypa.io/get-pip.py | python`
* Install all the dependencies from the requirements.txt file by running `python3.6 pip install -r requirements.txt`
* Create a database and edit the database configurations in `settings.py` to your own credentials.
* Make migrations
$ python manage.py makemigrations photos
$ python3.6 manage.py migrate
* To run the application, in your terminal:
$ python3.6 manage.py runserver
## Testing the Application
* To run the tests for the class file:
$ python3.6 manage.py test photos
## Technologies Used
- Python 3.6.8
- Django MVC framework
- HTML, CSS and Bootstrap
- Postgressql
- Heroku
## Support and contact details
For feedback contact me through;
* mark.macharia@student.moringaschool.com
* 0759329269
### License
[MITlicense](LICENSE) 2021