add README.md

README.md

@@ -1 +1,99 @@
-# Flask User Registration System
+# Flask Boilerplate app with user managment system
+
+#####Introduction
+Flask is microframework for web development written in Python. It's very easy and powerfull. We have created a simple Flask-Boilerplate app that many of you might need to get started with your first project. The app has a capability of registering users. Each user can publish a post and comment.
+
+#####Packages included
+######Flask-Security
+Flask-Security allows you to quickly add common security mechanisms to your Flask application. They include:
+
+- Session based authentication
+- Role management
+- Password encryption
+- Basic HTTP authentication
+- Token based authentication
+- Token based account activation (optional)
+- Token based password recovery / resetting (optional)
+- User registration (optional)
+- Login tracking (optional)
+- JSON/Ajax Support
+
+######Flask-WTF Forms
+WTF Forms is one of the most widely used package that you will almost used in any Flask application. It includes
+
+- Integration with wtforms.
+- Secure Form with csrf token.
+- Global csrf protection.
+- Recaptcha supporting.
+- File upload that works with Flask-Uploads.
+- Internationalization integration.
+
+######Flask Mongoengine
+MongoEngine is an Object-Document Mapper, written in Python for working with MongoDB. We have used mongoengine in our app to add/get data from MongoDB. Alternatively you can use PyMongo as well.
+
+#####Quick Start
+######1. Clone the repo
+Fisrt of al you'll need to clone the repo into your working directory and then cd into Flask-Boilerplate.
+
+    $ git clone https://github.com/redbricksystems/flask-boilerplate.git
+    $ cd flask-boilerplate
+
+######2. Create and activate a virtualenvironment
+After cloning a repo you'll have to create a virtual environment for your project and activate it using the following commands.
+
+    $ virtualenv venv
+    $ . venv/bin/activate   (for Ubuntu/Linux)
+    $ cd venv, cd Script, activate (for windows)
+
+######3. Configuration
+
+Now inorder to do that cd into the *main_app* and open up *settings.py* in your favorite text editor.
+
+**Database Configuration**<br>
+Add your database credentials
+
+    ...
+    #--------DB Config------------
+    MONGODB_SETTINGS = {
+    'DB':  'DB_NAME',
+    'USERNAME': 'DB_USERNAME',
+    'PASSWORD': 'DB_PASSWORD',
+    'HOST': 'HOST_LINK',
+    'PORT': PORT
+    }
+    ...
+
+**Mail Configuration**<br>
+Enter your email account information here for sending notifications like registring/account-activation/reset-passwod via this account.
+
+	...
+    #--------Mail Config---------
+    MAIL_SERVER = "smtp.gmail.com"
+    MAIL_PORT = 465
+    MAIL_USE_SSL = True
+    MAIL_USERNAME = 'YOUR_EMAIL'
+    MAIL_PASSWORD = 'YOUR_EMAIL_PASSWORD'
+    ...
+
+**Defaults Routes Configuration**<br>
+You can change any of the default route here in *settings.py*. You can change them too according to your need. These html templates can be found under /main_app/templates directory.
+
+######4. Install the dependencies
+Now after configuring your settings, its time to install all the required dependencies for the project. Run the following command to do so,
+
+`$ pip install -r requirements.txt`
+
+######5. Run the server
+Run the following command to start the development server.
+
+`$ python manage.py runserver`
+
+######6. Open up in your web browser
+Open up your web browser and navigate to **localhost:5000** and you'll probably see the running app. You can register and login via main page. And also after login you can add posts and comments.
+
+#####What's Next?
+
+- Adding Bootstrap to your flask app
+- Adding update/delete function on posts
+- Deploy your flask app on heroku platform
+- adding Unit tests by using Python Nose package