README.md

Cloud Flash Cards

I'm currently studying data structures and algorithms in preparation for software engineering interviews, but I was finding it hard to retain information without having a system in place to help me revisit previously studied topics, which is where the flashcard system came in. The problem was that I wanted something online that was easy to use so I could study anywhere and anytime without needing to be at my desk, but I couldn't really find anything out there that fit my needs so I decided to make my own!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

• React
• ExpressJS
• MySQL
• Bootstrap

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/sudo-dco/flashcards.git

2. Install NPM packages

   npm install

3. Install MySQL and run script to create database and table

   mysql -u root > ./database/script.sql

4. Run server and navigate to http://localhost:3000

   npm run server

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

Daniel Co - [email protected]

Project Link: https://github.com/sudo-dco/flashcards