revvviews

A Django application that allows users to post their projects and get them reviewed by their peers

Getting Started

These instructions will get you copy of this project up and running for local development and testing purposes.

Requirements

• Python
• Pipenv
  • pip install pipenv
• Git
• PostgreSQL

Setup and Installation

1. Clone this repository using git clone. Then, change your working directory to the repository.

   $ git clone https://github.com/trucktar/revvviews.git
   $ cd revvviews/
   

2. Install project and development dependencies.

   $ pipenv sync
   

3. Activate the project's virtualenv

   $ pipenv shell
   

Database Configuration

Ensure you have PostgreSQL installed and running. Then,

1. Enter psql, a terminal-based front-end to PostgreSQL:

   $ psql -U postgres
   

2. Run the following queries to create the db role and database.

   postgres=# CREATE USER revvviews WITH CREATEDB;
   postgres=# CREATE DATABASE revvviews OWNER revvviews;
   

Launching the application

1. Create a .env file and set the following env variables:

   DATABASE_URL=postgres://revvviews@localhost/revvviews
   SECRET_KEY=suitable-for-development-only
   

2. Run the following commands to create the database tables:

   python manage.py makemigrations
   python manage.py migrate
   

3. Create a superuser account.

   python manage.py createsuperuser
   

4. Finally, fire up the server and navigate to http://127.0.0.1:8000/

   python manage.py runserver
   

Built using

• Django - The web framework for perfectionists with deadlines.
• Bootstrap - The world’s most popular framework for building responsive, mobile-first sites.

Credits

Nyota Mwangi

License

Distributed under the MIT License. See LICENSE for more information.