rimij405/igme430-mindr

Mindr - A study application to help you track the things you want to remember.

Mindr

Mindr - A study application to help you track the things you want to remember.

About the Project

Mindr is a study application proof-of-concept that helps users memorize topics of their choice. This project is created in partial fulfillment of the requirements for the IGME 430: Rich Media Web Application Development II course offered at the Rochester Institute of Technology.

Ian Effendi (@rimij405) is a software designer and developer. This project was created as part of their coursework while enrolled at the Rochester Institute of Technology.

Distributed under the MIT License. See LICENSE for more information.

Development Setup

In order to develop Mindr, you'll need to have access to Node and npm.

Steps to develop this project:

1. Clone this repository.
2. Run npm install in the root directory.
3. Run npm run serve to serve project with nodemon.

Attributions

This project uses the following libraries, packages, tools, and resources:

• Node.JS - A JavaScript runtime built on Chrome's V8 JavaScript engine.
• npm - A package manager used for Node.JS projects.
• CircleCI - Continuous integration solution.
• milligram - A lightweight CSS framework.
• Heroku - Deployment solution for server-based applications, websites, services, and projects.

Contribution Guidelines

This project is not open to contributions from others at the present moment. If you would like to expand upon this proof-of-concept, the code herein is licensed under the permissible MIT license.

You are more than welcome to fork this repository to host your own derivative project.

igme430-mindr's Issues

[FEAT] Salt passwords

Summarize the feature succinctly here.
Salt user passwords when creating the login functionality.

[FEAT] Organize folder structure

Summarize the feature succinctly here.
Organize the folder structure and break project up into proper layers.

Describe the solution you'd like
Consider dealing with:

• API Route Controller
• Service Layer
• Pub/Sub Layer
• Data Access Layer
• Configuration Layer
• Loader Layer

Relevant links
The following references will help:

• blog-express project by azat-co.
• Bulletproof node.js project architecture (article) and bulletproof-nodejs (repo) by santiq.

[FEAT] Unit test suite of Mocha + expect.js

Summarize the feature succinctly here.
Provide a unit testing suite using Mocha (by mochajs) and express.js (by Automattic).

Describe the solution you'd like
Create and prepare a test suite for this project.

Relevant links

• How To Use Mocha With Node.js For Test-Driven Development to Avoid Pain and Ship Products Faster by Azat Mardan, author of Practical Node.
• Testing RESTful APIs by Azat Mardan.
• How to test JavaScript with Mocha - The Basics (Part 1) (Part 2) by Brandon Morelli.
• mochajs.org.
• The Ultimate Unit Testing Cheatsheet by yoavniran.
• Getting Started with Node.js and Mocha by Igor Šarčević
  .

[FEAT] CircleCI Integration

Summarize the feature succinctly here.
Setup continuous integration with CircleCI.

[FEAT] Deploy to Heroku

Summarize the feature succinctly here.
Setup application to deploy to Heroku once CI tests complete.