Skip to content

Commit

Permalink
docs: Explain Setup, Features
Browse files Browse the repository at this point in the history
  • Loading branch information
yogykwan committed Mar 27, 2017
1 parent 03ae6b8 commit 44d451f
Showing 1 changed file with 12 additions and 43 deletions.
55 changes: 12 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,18 @@
fsnd: a multi user blog(along the lines of Medium) where users can sign in and post blog posts as well as 'Like' and 'Comment' on other posts made on the blog.

## Setup
- Install Python if necessary.
- Install Google App Engine SDK.
- Sign Up for a Google App Engine Account.
- Create a new project in Google’s Developer Console using a unique name.
- Follow the App Engine Quickstart to get a sample app up and running.
- Deploy your project with gcloud app deploy.
- View your project at unique-name.appspot.com.
- You should see “Hello World!”
- When developing locally, you can use dev_appserver.py to run a copy of your app on your own computer, and access it at http://localhost:8080/.
- Install Jinja and create helper functions for using Jinja, follow the directions here.
- If you’re unfamiliar with Jinja watch Lesson 2 and/or check out the docs.

## Step 1: Create a Basic Blog
- Blog must include the following features:
- Front page that lists blog posts.
- A form to submit new entries.
- Blog posts have their own page.
- View instructions and solutions here.
- [install google app engine](https://drive.google.com/open?id=0Byu3UemwRffDc21qd3duLW9LMm8)
- create app in [Developer Console](https://console.developers.google.com/)
- run locally `dev_appserver.py .`
- browse locally via [http://localhost:8080](http://localhost:8080)
- set project `gcloud config set project PROJECT_ID`
- deploy app `gcloud app deploy`
- browse app `gcloud app browse`

## Step 2: Add User Registration
- Have a registration form that validates user input, and displays the error(s) when necessary.
- After a successful registration, a user is directed to a welcome page with a greeting, “Welcome, [User]” where [User] is a name set in a cookie.
- If a user attempts to visit the welcome page without being signed in (without having a cookie), then redirect to the Signup page.
- Watch the demo for more details.
- Be sure to store passwords securely.
## Features

## Step 3: Add Login
- Have a login form that validates user input, and displays the error(s) when necessary.
- After a successful login, the user is directed to the same welcome page from Step 2.
- Watch the demo for more details.

## Step 4: Add Logout
- Have a logout form that validates user input, and displays the error(s) when necessary.
- After logging out, the cookie is cleared and user is redirected to the Signup page from Step 2.
- Watch the demo for more details.

## Step 5: Add Other Features on Your Own
- Users should only be able to edit/delete their posts. They receive an error message if they disobey this rule.
- Users can like/unlike posts, but not their own. They receive an error message if they disobey this rule.
- Users can comment on posts. They can only edit/delete their own comments, and they should receive an error message if they disobey this rule.

## Step 6: Final Touches
- Create a README.md file explaining how to run your code.
- Refactor your code so it is well structured, well commented, and conforms to the Python Style Guide.
- Make sure your project conforms to the rubric.
- Deploy your app to appspot.com using gcloud app deploy.
- user - signup, login, logout
- post - new, edit, delete, display
- comment - new, delete, edit
- like - add, delete

0 comments on commit 44d451f

Please sign in to comment.