Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/machel54/awards
Awwards is an application that allows users to post projects that they have created and get it reviewed by their peers.
https://github.com/machel54/awards
Last synced: 9 days ago
JSON representation
Awwards is an application that allows users to post projects that they have created and get it reviewed by their peers.
- Host: GitHub
- URL: https://github.com/machel54/awards
- Owner: Machel54
- Created: 2019-11-22T11:01:42.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-08T01:27:05.000Z (over 3 years ago)
- Last Synced: 2024-11-16T21:12:36.767Z (2 months ago)
- Language: Python
- Homepage: https://awwardss.herokuapp.com
- Size: 25.5 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](http://opensource.org/licenses/MIT)
#### Author
> Machel Nyanumba.
## Description
Awwards is an application that allows users to post projects that they have created and get it reviewed by their peers.
A project can be rated based on 3 different criteria
* Design
* Usability
* Content
## Setup Instructions:
### Requirements
##### 1. Clone the repository
Clone the the repository by running
```bash
git clone https://github.com/Machel54/Awards.git
```
or download a zip file of the project from github
Navigate to the project directory
```bash
cd Awwards
```
##### 2. Create a virtual environment
Install `Virtualenv`
```prettier
pip install virtualenv
```
To create a virtual environment named `virtual`, run
```prettier
virtualenv virtual
```
To activate the virtual environment we just created, run
```bash
source virtual/bin/activate
```
##### 3. Create a database
You'll need to create a new postgress database, Type the following command to access postgress
```bash
$ psql
```
Then run the following query to create a new database named ```Awards```
```prettier
# create database Awards
```
##### 4.Install dependencies
To install the requirements from `requirements.txt` file,
```prettier
pip install -r requirements.txt
```
##### 5.Create Database migrations
Making migrations on postgres using django
```prettier
python3 manage.py makemigrations awards
```
then run the command below;
```bash
python3 manage.py migrate
```
##### 6.Run the app
To run the application on your development machine,
python3 manage.py runserver
### Running Tests
>To run tests;
python3 manage.py test
## Technologies Used
* Django
* Python
* Html
* Css
* Javascript
* Bootstrap
## User stories
>As a user of the application I should be able to:
- [X] View posted projects and their details
- [X] Post a project to be rated/reviewed
- [X] Rate/ review other users' projects
- [X] Search for projects
- [X] View projects overall score
- [X] View my profile page
## Bugs
There are no know bugs at the moment
## License
[](http://opensource.org/licenses/MIT)
>MIT license © 2019 Machel
## Collaboration Information
* Clone the repository
* Make changes and write tests
* Push changes to github
* Create a pull request
## Contacts
Reach me on:
>Email: [email protected]