The mydiary from kenneth051

mydiary's Introduction

MyDiary is a website that enables someone to record their daily activities,personal affairs as well as emotions that may occur from time to time. One registers, logs in and then he or she starts writing.

The UI pages have been developed with HTML, CSS and Javascript

The link to the UI pages is https://kenneth051.github.io/MyDiary/UI/index.html

The link to heroku is https://bootcamp-challenge2.herokuapp.com/API/v1/entries

FEATURES OF MYDIARY

		-Creating an account

		-logging into the account

		-Entering content(Writitng)

		-Viewing all entries

		-Viewing a specific entry

		-Updating an entry

MY DIARY'S ENDPOINTS

		METHOD             ACTIVITY                     ENDPOINT

		-GET             fetching all entries           /API/v1/entries

		-POST            Creating an entry              /API/v1/entries

		-GET             Fething a specific entry       /API/v1/entries/<int:entryid>

		-PUT             Updating a specific entry      /API/v1/entries/<int:entryid>

GETTING STARTED WITH MY DIARY

1- Clone the repository to your computer

-git clone https://github.com/kenneth051/MyDiary.git

2-Install a virtual enviroment

		-pip install virtaulenv
		-in the projects root directory, create a virtual enviroment
		-virtualenv "Name of virtaulenv here without the qoutes"
		-activate the virtual env, in your project's root directory

	-on windows
		"virtual_env_folder_name_here"\Scripts\activate
    -on a mac
        source bin/activate

3-Install the dependencies in your virtual enviroment

	    -pip install -r requirements.txt

4-Run the application when you are in it's parent directory

	    -python run.py

Testing

To run tests #in root directory

        pytest --cov

-pytest --cov

The endpoints have been developed Using Python OOP based together with Flask framework implementing non persistent data using data structures for storage.

Recommend Projects