Skip to content

nMeme is an app that allows users to create, study and share flashcards.

License

Notifications You must be signed in to change notification settings

skysuzuki/mNeme-iOS

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mNeme

You can find the deployed project at Testflight.

Contributors

Dennis Rudolph Niranjan Kumar Skyler Suzuki

Swift Version Build Status License CocoaPods Compatible
Platform

Project Overview

You can find the deployed project at Testflight.

mNeme iOS Trello Board

Product Canvas

Figma

The general overview of the iOS nMeme app is to allow users to create, study and share flashcards.

For the current version 1.1 of the iOS app, Users can create and study flashcards while at their desk and on the go. The following features were built for responsive CRUD functionality for flashcards and deck

Features

  • Responsive sign-up/ login authentication process using Firebase with login of their choice (FB, Google, Email)
  • Demo deck that can be viewed and flipped through to understand the flow of studying
  • Home dashboard framework implemented, where future metrics will be housed
  • User preferences can be set up and saved, pushing information up to our database for data collection
  • Users should be able to easily create, edit, archive and delete a card
  • Users should be able to easily create, edit, archive, and delete a deck
  • Users should be able to seamlessly view the cards inside of a deck and manipulate as needed for studying

Authentication API

Firebase Auth

Cocoapods

  • Firebase
  • Firebase/Auth
  • Firebase/Analytics
  • SOTabBar
  • GoogleSignIn
  • FacebookLogin
  • FacebookCore
  • TaggerKit

Requirements

  • iOS 8.0+
  • Xcode 7.3
  • Cocoa Pods

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

## Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

About

nMeme is an app that allows users to create, study and share flashcards.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Swift 99.7%
  • Ruby 0.3%