/Ratemyproject

This application allows a user to post their projects for other users to rate the project based on design, usability, and content.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Project Name

Ratemyproject

Author

Joy Marocho

Table of Content

Project Description

This application allows a user to post their projects for other users to rate the project based on design, usability, and content.

Application Behaviours

As the application's user you will be able to:

  1. View posted projects and their details.
  2. Post a project to be rated/reviewed.
  3. Rate/review other users' projects.
  4. Search for projects.
  5. View your project's overall score and that of other users.
  6. View the project owner's profile page.

Go Back to the top

Installation and setup instructions

  1. Clone this repo: git clone https://github.com/JoyMarocho/Ratemyproject.git

  2. Open your terminal and navigate to the cloned folder then create a virtual environment.For detailed guide refer here

  3. To run the app, you'll have to run the following commands in your terminal

     pipenv install -r requirements.txt
    
  4. On your terminal, Create a database for the application using the command below.

     CREATE DATABASE <database_name>;
    
  5. Migrate the database using the command below

     make migrate
    
  6. Then serve the app, so that the app will be available on localhost:8000, to do this run the command below

     make serve
    
  7. Use the navigation bar/navbar/navigation pane/menu to navigate and explore the app.

Running the tests

Use the command given below to run automated tests.

    make test

Go Back to the top

Technologies Used

  • Django - Web Framework
  • Python - For functionality
  • HTML - For building Mark Up pages/User Interface
  • CSS - For Styling User Interface

Known Bugs

No known bugs at the moment.

Contacts

Live Link

License

GNU GPL v3.0

Copyright (c) [2022] Joy Marocho

Go Back to the top