itsmistad / Mirai

An intuitive web application for daily organizing

Mirai

Mirai is an intuitive web application for daily organizing and planning.

CSCE 4901.070 Team Name: Alpha

	master – what's deployed	develop – what's code-complete
Build
Version	0.3.3	0.3.3
Live Url	https://miraiapp.co/	http://dev.miraiapp.co:3000/

Here's what it does:

1. Provides a minimalist and intuitive interface to plan out your schedule and day-to-day life.
2. Keeps your life organized and easily displayed in the form of tasks.
3. Provides multi-use functionality.
4. Allows task assigning and allows you to share your progress.
5. Allows you to assign yourself due dates and set reminders.

This code is open-source under the MIT License.

Contributors

itsmistad - Derek Williamson

tylercarey98 - Tyler Carey

apikus - Anna Pikus

anguyen122 - Anthony Nguyen

Development

Requirements

1. bash (for Windows users, this can be obtained from GitBash or cmder)
2. Node.js
3. MongoDB

Setup

npm Packages

Download and install Node.js (which comes packaged with npm). Run this command in the base directory of the repository:

npm install

Your local repository should now be up-to-date with all the required packages for the application.

MongoDB

Download and install MongoDB Community Server. Keep all settings as default during installation.

Your local database should now be up-and-running with the following connection string: mongodb://localhost:27017

Testing

From the base directory of the repo, run this to execute all tests:

npm test

Executing

Navigate to ./scripts/ and execute this script to (1) run any necessary migrations, (2) run all unit tests, and (3) start a local Mirai instance:

./start.sh

Execute this script to start gulp with the BrowserSync and Sass tasks:

./watch.sh

Your local instance of Mirai should be running and accessible at the following address: http://localhost:3000/