https://github.com/danrpts/welcome_mail

Simple email application built for GMail and easily modified for any REST API.
https://github.com/danrpts/welcome_mail

backbone gmail

Last synced: 9 days ago
JSON representation

Simple email application built for GMail and easily modified for any REST API.

• Host: GitHub
• URL: https://github.com/danrpts/welcome_mail
• Owner: danrpts
• License: gpl-3.0
• Created: 2016-09-06T21:47:24.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-10-25T17:20:35.000Z (over 8 years ago)
• Last Synced: 2025-10-29T21:45:55.718Z (9 months ago)
• Topics: backbone, gmail
• Language: JavaScript
• Homepage:
• Size: 490 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Welcome Mail

A webmail application focused on delivering a simplified user experience to email.

![inbox](screenshots/frame-welcomemail-inbox.png)

## Installation

This application is a demo that installs with [Webstack](https://github.com/danrpts/webstack), a boilerplate project for building JavaScript single page applications with Gulp, Express, and Backbone. To install Welcome Mail we must simply clone and install Webstack:

    git clone https://github.com/danrpts/webstack.git

    cd webstack

    npm install -g gulp express

    npm install

## Configuration

This web application consumes [RFC 2822](https://tools.ietf.org/html/rfc2822) messages served from a REST API and authenticates with OAuth 2.0, by default it uses [GMail's REST API](https://developers.google.com/gmail/api/v1/reference/) and [Google's OAuth 2.0 Client Side Flow](https://developers.google.com/identity/protocols/OAuth2UserAgent). When authenticating with Google OAuth 2.0 you must update the `client_id` and `client_secret` [credentials](https://developers.google.com/identity/protocols/OAuth2UserAgent#creatingcred) found in the following files:

 - webstack/webserver/config/google_config.json and

 - webstack/webclient/webmail/javascripts/config/google.json

## Usage

To start the Welcome Mail application we simply run two scripts from our root webstack/ directory. We first tell Gulp to build and watch the project, and then **in a new terminal we** run our npm start script to serve it. By default, the application will be served at [http://localhost:3000](http://localhost:3000).

Terminal 1:

    gulp --client webmail

    

Terminal 2:

    npm start

## Contributing

Please submit all issues and pull request to the [Webstack](https://github.com/danrpts/webstack) repository!

## Credits

Daniel Peterson 

## License

GPL-3.0