/mobile-flashcards

Mobile Flashcards project for Udacity ND

Primary LanguageJavaScriptMIT LicenseMIT

Mobile Flashcards

Just a simple application that will help you to achieve your goals.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need Git and Yarn (or npm) installed locally to continue.

Check if Git is installed locally.

Run the following command:

git --version

If you have git installed, you should see something like the following result:

git version 2.18.0

If not, please check this link and complete the installation before continue.

Check if Yarn is installed locally (if you prefer npm skip this step)

Run the following command:

yarn --version

if you have yarn installed, you should see something like the following result:

1.7.0

If not, please check this link and complete the installation before continue.

Check if npm is installed locally (you'll need to do this step if you skiped the previous one about Yarn installation)

Run the following command:

npm --version

if you have npm installed, you should see something like the following result:

6.4.1

If not, please check this link and complete the installation before continue.

Installing

Clone the repository locally on your machine following the next command:

git clone https://github.com/sebastianferrari/mobile-flashcards.git

Go to the generated root folder after the clone action and run the following command in order to restore all packages:

yarn install

or

npm install

Running the application

Just run the following command:

yarn start

or

npm start

Running the tests

Comming soon

Deployment

Comming soon

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Just be nice and enjoy your work!