Online Diary V-2

MyDiary is an online journal where users can pen down their thoughts and feelings.

Documentation: https://mydiaryrestapi.docs.apiary.io/

Heroku Link: https://online-diary-v1.herokuapp.com/

Endpoints

Functionality	Method	Endpoint
Get all entries	GET	/mydiary/v1/entries
Get specific entry	GET	/mydiary/v1/entries/id
Add an entry	POST	/mydiary/v1/entries
Modify an entry	PUT	/mydiary/v1/entries/id
Delete an entry	DELET	/mydiary/v1/entries/id
Register	POST	/mydiary/v1/auth/register
Login	POST	/mydiary/v1/auth/login

Requirements

• Python3 (programming language)
• Flask (Python webframework)
• Virtualenv(To isolate Api modules)
• Pytest (Tool for testing)
• Postgresql (Database used)

How to setup it up:

To set it up in your machine:

1.sudo install python3

2.pip install virtualenv

Clone this repository:

git clone https://github.com/charisschomba/Diary.git

cd Diary/

Create a virtual environment in the root directory:

virtualenv [name of virtualenv]

Activate the virtualenv:

source [name of virtualenv]/bin/activate

On your terminal run:

pip install -r requirements.txt to install the modules

switch to postgres user with;

sudo -i -u postgres or su postgres

create database

createdb database_name

create user

psql -c "CREATE USER db_user WITH PASSWORD 'password' createdb" -U postgres

Cd to challenge3/app

run

python create_database.py

to create the two tables required

On your terminal run:

export FLASK_APP="run.py"

export FLASK_ENV="development"

export JWT_SECRET_KEY="anyrandomlongstring"

export DB_HOST="localhost"

export DB_NAME="database_name"

export DB_USERNAME="db_user"

export DB_PASSWORD="password"

export SECRET_KEY="any randomlongstring"

Run the application:

flask run

use the above specified endpoints in the table for testing.

To run tests:

cd to Diary/challenge3 folder

pytest

run

pylint

for code rating.