vikashiscool / moneta

A web app to incentivize responsible investing: A General Assembly Labs collaboration
0 stars 0 forks source link

Moneta

Introduction

Welceome to Moneta, a web application to incentivize responsible investing, as a part of a General Assembly Labs collaboration between the Product Management Immersive, the Web Development Immersive, and User Experience Design Immersive programs.

Architecture

These sections roughly describe the technologies used in the development of this application for others who might continue working on it. While list is extensive, it is comprehensive enough to give a sense of how the app works.

Languages/Frameworks

A MEAN stack app, this project is built primarily with Javascript, specifically Node.js with Express on the back-end, Angular on the front-end, and MongoDB to handle data. For design, HTML5/CSS3 will be used, as well as a Bootstrap.

Security

(Oauth2 or Passport) is currently being used for authentication, with integration with Facebook, Google, and Twitter. The app also utilizes XXXXX to allow keys to be initialized locally and avoid having them in the codebase.

APIs

Business Logic

index.js: Creates the server, connects the app to the relevant Mongo database, and serves static files.

./public/scripts/app.js: Handles application routing using Angular UI router.

./models/user.js and ./models/todo.js: Define the user and todo model, respectively.

User Stories

Home page (index.html)

As a VISITOR I can...

Profile page (user/index.html):

As a USER I can...

Edit profile page (user/edit.html):

As a USER I can...

User show (user/*/show.html):

As a USER I can...

As an ADMIN-USER I can...

Contributors

Developers

Product Managers

User Experience and Design

Contact and contributions

Please contact us via Twitter if you have any questions or want to contribute to this project!